Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "generated/Endpoints"

Index

Interfaces

Type aliases

Type aliases

ActionsAddSelectedRepoToOrgSecretEndpoint

ActionsAddSelectedRepoToOrgSecretEndpoint: { org: string; repository_id: number; secret_name: string }

Type declaration

  • org: string
  • repository_id: number
  • secret_name: string

ActionsAddSelectedRepoToOrgSecretRequestOptions

ActionsAddSelectedRepoToOrgSecretRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/actions/secrets/:secret_name/repositories/:repository_id" }

Type declaration

ActionsCancelWorkflowRunEndpoint

ActionsCancelWorkflowRunEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string
  • repo: string
  • run_id: number

ActionsCancelWorkflowRunRequestOptions

ActionsCancelWorkflowRunRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id/cancel" }

Type declaration

ActionsCreateOrUpdateOrgSecretEndpoint

ActionsCreateOrUpdateOrgSecretEndpoint: { encrypted_value?: undefined | string; key_id?: undefined | string; org: string; secret_name: string; selected_repository_ids?: number[]; visibility?: "all" | "private" | "selected" }

Type declaration

  • Optional encrypted_value?: undefined | string

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

  • Optional key_id?: undefined | string

    ID of the key you used to encrypt the secret.

  • org: string
  • secret_name: string
  • Optional selected_repository_ids?: number[]

    An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

  • Optional visibility?: "all" | "private" | "selected"

    Configures the access that repositories have to the organization secret. Can be one of: - all - All repositories in an organization can access the secret. - private - Private repositories in an organization can access the secret. - selected - Only specific repositories can access the secret.

ActionsCreateOrUpdateOrgSecretRequestOptions

ActionsCreateOrUpdateOrgSecretRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/actions/secrets/:secret_name" }

Type declaration

ActionsCreateOrUpdateRepoSecretEndpoint

ActionsCreateOrUpdateRepoSecretEndpoint: { encrypted_value?: undefined | string; key_id?: undefined | string; owner: string; repo: string; secret_name: string }

Type declaration

  • Optional encrypted_value?: undefined | string

    Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

  • Optional key_id?: undefined | string

    ID of the key you used to encrypt the secret.

  • owner: string
  • repo: string
  • secret_name: string

ActionsCreateOrUpdateRepoSecretRequestOptions

ActionsCreateOrUpdateRepoSecretRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/secrets/:secret_name" }

Type declaration

ActionsCreateRegistrationTokenForOrgEndpoint

ActionsCreateRegistrationTokenForOrgEndpoint: { org: string }

Type declaration

  • org: string

ActionsCreateRegistrationTokenForOrgRequestOptions

ActionsCreateRegistrationTokenForOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/actions/runners/registration-token" }

Type declaration

ActionsCreateRegistrationTokenForRepoEndpoint

ActionsCreateRegistrationTokenForRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActionsCreateRegistrationTokenForRepoRequestOptions

ActionsCreateRegistrationTokenForRepoRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runners/registration-token" }

Type declaration

ActionsCreateRemoveTokenForOrgEndpoint

ActionsCreateRemoveTokenForOrgEndpoint: { org: string }

Type declaration

  • org: string

ActionsCreateRemoveTokenForOrgRequestOptions

ActionsCreateRemoveTokenForOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/actions/runners/remove-token" }

Type declaration

ActionsCreateRemoveTokenForRepoEndpoint

ActionsCreateRemoveTokenForRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActionsCreateRemoveTokenForRepoRequestOptions

ActionsCreateRemoveTokenForRepoRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runners/remove-token" }

Type declaration

ActionsCreateWorkflowDispatchEndpoint

ActionsCreateWorkflowDispatchEndpoint: { inputs?: ActionsCreateWorkflowDispatchParamsInputs; owner: string; ref: string; repo: string; workflow_id: number }

Type declaration

  • Optional inputs?: ActionsCreateWorkflowDispatchParamsInputs

    Input keys and values configured in the workflow file. The maximum number of properties is 10.

  • owner: string
  • ref: string

    The reference of the workflow run. The reference can be a branch, tag, or a commit SHA.

  • repo: string
  • workflow_id: number

ActionsCreateWorkflowDispatchParamsInputs

ActionsCreateWorkflowDispatchParamsInputs: {}

Type declaration

ActionsCreateWorkflowDispatchParamsInputsKeyString

ActionsCreateWorkflowDispatchParamsInputsKeyString: {}

Type declaration

ActionsCreateWorkflowDispatchRequestOptions

ActionsCreateWorkflowDispatchRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/workflows/:workflow_id/dispatches" }

Type declaration

ActionsDeleteArtifactEndpoint

ActionsDeleteArtifactEndpoint: { artifact_id: number; owner: string; repo: string }

Type declaration

  • artifact_id: number
  • owner: string
  • repo: string

ActionsDeleteArtifactRequestOptions

ActionsDeleteArtifactRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/artifacts/:artifact_id" }

Type declaration

ActionsDeleteOrgSecretEndpoint

ActionsDeleteOrgSecretEndpoint: { org: string; secret_name: string }

Type declaration

  • org: string
  • secret_name: string

ActionsDeleteOrgSecretRequestOptions

ActionsDeleteOrgSecretRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/actions/secrets/:secret_name" }

Type declaration

ActionsDeleteRepoSecretEndpoint

ActionsDeleteRepoSecretEndpoint: { owner: string; repo: string; secret_name: string }

Type declaration

  • owner: string
  • repo: string
  • secret_name: string

ActionsDeleteRepoSecretRequestOptions

ActionsDeleteRepoSecretRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/secrets/:secret_name" }

Type declaration

ActionsDeleteSelfHostedRunnerFromOrgEndpoint

ActionsDeleteSelfHostedRunnerFromOrgEndpoint: { org: string; runner_id: number }

Type declaration

  • org: string
  • runner_id: number

ActionsDeleteSelfHostedRunnerFromOrgRequestOptions

ActionsDeleteSelfHostedRunnerFromOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/actions/runners/:runner_id" }

Type declaration

ActionsDeleteSelfHostedRunnerFromRepoEndpoint

ActionsDeleteSelfHostedRunnerFromRepoEndpoint: { owner: string; repo: string; runner_id: number }

Type declaration

  • owner: string
  • repo: string
  • runner_id: number

ActionsDeleteSelfHostedRunnerFromRepoRequestOptions

ActionsDeleteSelfHostedRunnerFromRepoRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runners/:runner_id" }

Type declaration

ActionsDeleteWorkflowRunEndpoint

ActionsDeleteWorkflowRunEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string
  • repo: string
  • run_id: number

ActionsDeleteWorkflowRunLogsEndpoint

ActionsDeleteWorkflowRunLogsEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string
  • repo: string
  • run_id: number

ActionsDeleteWorkflowRunLogsRequestOptions

ActionsDeleteWorkflowRunLogsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id/logs" }

Type declaration

ActionsDeleteWorkflowRunRequestOptions

ActionsDeleteWorkflowRunRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id" }

Type declaration

ActionsDownloadArtifactEndpoint

ActionsDownloadArtifactEndpoint: { archive_format: string; artifact_id: number; owner: string; repo: string }

Type declaration

  • archive_format: string
  • artifact_id: number
  • owner: string
  • repo: string

ActionsDownloadArtifactRequestOptions

ActionsDownloadArtifactRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format" }

Type declaration

ActionsDownloadJobLogsForWorkflowRunEndpoint

ActionsDownloadJobLogsForWorkflowRunEndpoint: { job_id: number; owner: string; repo: string }

Type declaration

  • job_id: number
  • owner: string
  • repo: string

ActionsDownloadJobLogsForWorkflowRunRequestOptions

ActionsDownloadJobLogsForWorkflowRunRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/jobs/:job_id/logs" }

Type declaration

ActionsDownloadWorkflowRunLogsEndpoint

ActionsDownloadWorkflowRunLogsEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string
  • repo: string
  • run_id: number

ActionsDownloadWorkflowRunLogsRequestOptions

ActionsDownloadWorkflowRunLogsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id/logs" }

Type declaration

ActionsGetArtifactEndpoint

ActionsGetArtifactEndpoint: { artifact_id: number; owner: string; repo: string }

Type declaration

  • artifact_id: number
  • owner: string
  • repo: string

ActionsGetArtifactRequestOptions

ActionsGetArtifactRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/artifacts/:artifact_id" }

Type declaration

ActionsGetJobForWorkflowRunEndpoint

ActionsGetJobForWorkflowRunEndpoint: { job_id: number; owner: string; repo: string }

Type declaration

  • job_id: number
  • owner: string
  • repo: string

ActionsGetJobForWorkflowRunRequestOptions

ActionsGetJobForWorkflowRunRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/jobs/:job_id" }

Type declaration

ActionsGetOrgPublicKeyEndpoint

ActionsGetOrgPublicKeyEndpoint: { org: string }

Type declaration

  • org: string

ActionsGetOrgPublicKeyRequestOptions

ActionsGetOrgPublicKeyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/actions/secrets/public-key" }

Type declaration

ActionsGetOrgSecretEndpoint

ActionsGetOrgSecretEndpoint: { org: string; secret_name: string }

Type declaration

  • org: string
  • secret_name: string

ActionsGetOrgSecretRequestOptions

ActionsGetOrgSecretRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/actions/secrets/:secret_name" }

Type declaration

ActionsGetRepoPublicKeyEndpoint

ActionsGetRepoPublicKeyEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActionsGetRepoPublicKeyRequestOptions

ActionsGetRepoPublicKeyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/secrets/public-key" }

Type declaration

ActionsGetRepoSecretEndpoint

ActionsGetRepoSecretEndpoint: { owner: string; repo: string; secret_name: string }

Type declaration

  • owner: string
  • repo: string
  • secret_name: string

ActionsGetRepoSecretRequestOptions

ActionsGetRepoSecretRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/secrets/:secret_name" }

Type declaration

ActionsGetSelfHostedRunnerForOrgEndpoint

ActionsGetSelfHostedRunnerForOrgEndpoint: { org: string; runner_id: number }

Type declaration

  • org: string
  • runner_id: number

ActionsGetSelfHostedRunnerForOrgRequestOptions

ActionsGetSelfHostedRunnerForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/actions/runners/:runner_id" }

Type declaration

ActionsGetSelfHostedRunnerForRepoEndpoint

ActionsGetSelfHostedRunnerForRepoEndpoint: { owner: string; repo: string; runner_id: number }

Type declaration

  • owner: string
  • repo: string
  • runner_id: number

ActionsGetSelfHostedRunnerForRepoRequestOptions

ActionsGetSelfHostedRunnerForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runners/:runner_id" }

Type declaration

ActionsGetWorkflowEndpoint

ActionsGetWorkflowEndpoint: { owner: string; repo: string; workflow_id: number }

Type declaration

  • owner: string
  • repo: string
  • workflow_id: number

ActionsGetWorkflowRequestOptions

ActionsGetWorkflowRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/workflows/:workflow_id" }

Type declaration

ActionsGetWorkflowRunEndpoint

ActionsGetWorkflowRunEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string
  • repo: string
  • run_id: number

ActionsGetWorkflowRunRequestOptions

ActionsGetWorkflowRunRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id" }

Type declaration

ActionsGetWorkflowRunUsageEndpoint

ActionsGetWorkflowRunUsageEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string
  • repo: string
  • run_id: number

ActionsGetWorkflowRunUsageRequestOptions

ActionsGetWorkflowRunUsageRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id/timing" }

Type declaration

ActionsGetWorkflowUsageEndpoint

ActionsGetWorkflowUsageEndpoint: { owner: string; repo: string; workflow_id: number }

Type declaration

  • owner: string
  • repo: string
  • workflow_id: number

ActionsGetWorkflowUsageRequestOptions

ActionsGetWorkflowUsageRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/workflows/:workflow_id/timing" }

Type declaration

ActionsListArtifactsForRepoEndpoint

ActionsListArtifactsForRepoEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActionsListArtifactsForRepoRequestOptions

ActionsListArtifactsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/artifacts" }

Type declaration

ActionsListJobsForWorkflowRunEndpoint

ActionsListJobsForWorkflowRunEndpoint: { filter?: "latest" | "all"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; run_id: number }

Type declaration

  • Optional filter?: "latest" | "all"

    Filters jobs by their completed_at timestamp. Can be one of: * latest: Returns jobs from the most recent execution of the workflow run. * all: Returns all jobs for a workflow run, including from old executions of the workflow run.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • run_id: number

ActionsListJobsForWorkflowRunRequestOptions

ActionsListJobsForWorkflowRunRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id/jobs" }

Type declaration

ActionsListOrgSecretsEndpoint

ActionsListOrgSecretsEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ActionsListOrgSecretsRequestOptions

ActionsListOrgSecretsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/actions/secrets" }

Type declaration

ActionsListRepoSecretsEndpoint

ActionsListRepoSecretsEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActionsListRepoSecretsRequestOptions

ActionsListRepoSecretsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/secrets" }

Type declaration

ActionsListRepoWorkflowsEndpoint

ActionsListRepoWorkflowsEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActionsListRepoWorkflowsRequestOptions

ActionsListRepoWorkflowsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/workflows" }

Type declaration

ActionsListRunnerApplicationsForOrgEndpoint

ActionsListRunnerApplicationsForOrgEndpoint: { org: string }

Type declaration

  • org: string

ActionsListRunnerApplicationsForOrgRequestOptions

ActionsListRunnerApplicationsForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/actions/runners/downloads" }

Type declaration

ActionsListRunnerApplicationsForOrgResponseData

ActionsListRunnerApplicationsForOrgResponseData: { architecture: string; download_url: string; filename: string; os: string }[]

ActionsListRunnerApplicationsForRepoEndpoint

ActionsListRunnerApplicationsForRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActionsListRunnerApplicationsForRepoRequestOptions

ActionsListRunnerApplicationsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runners/downloads" }

Type declaration

ActionsListRunnerApplicationsForRepoResponseData

ActionsListRunnerApplicationsForRepoResponseData: { architecture: string; download_url: string; filename: string; os: string }[]

ActionsListSelectedReposForOrgSecretEndpoint

ActionsListSelectedReposForOrgSecretEndpoint: { org: string; secret_name: string }

Type declaration

  • org: string
  • secret_name: string

ActionsListSelectedReposForOrgSecretRequestOptions

ActionsListSelectedReposForOrgSecretRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/actions/secrets/:secret_name/repositories" }

Type declaration

ActionsListSelfHostedRunnersForOrgEndpoint

ActionsListSelfHostedRunnersForOrgEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ActionsListSelfHostedRunnersForOrgRequestOptions

ActionsListSelfHostedRunnersForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/actions/runners" }

Type declaration

ActionsListSelfHostedRunnersForRepoEndpoint

ActionsListSelfHostedRunnersForRepoEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActionsListSelfHostedRunnersForRepoRequestOptions

ActionsListSelfHostedRunnersForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runners" }

Type declaration

ActionsListWorkflowRunArtifactsEndpoint

ActionsListWorkflowRunArtifactsEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; run_id: number }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • run_id: number

ActionsListWorkflowRunArtifactsRequestOptions

ActionsListWorkflowRunArtifactsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id/artifacts" }

Type declaration

ActionsListWorkflowRunsEndpoint

ActionsListWorkflowRunsEndpoint: { actor?: undefined | string; branch?: undefined | string; event?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; status?: "completed" | "status" | "conclusion"; workflow_id: number }

Type declaration

  • Optional actor?: undefined | string

    Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

  • Optional branch?: undefined | string

    Returns workflow runs associated with a branch. Use the name of the branch of the push.

  • Optional event?: undefined | string

    Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows."

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional status?: "completed" | "status" | "conclusion"

    Returns workflow runs associated with the check run status or conclusion you specify. For example, a conclusion can be success or a status can be completed. For more information, see the status and conclusion options available in "Create a check run."

  • workflow_id: number

ActionsListWorkflowRunsForRepoEndpoint

ActionsListWorkflowRunsForRepoEndpoint: { actor?: undefined | string; branch?: undefined | string; event?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; status?: "completed" | "status" | "conclusion" }

Type declaration

  • Optional actor?: undefined | string

    Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

  • Optional branch?: undefined | string

    Returns workflow runs associated with a branch. Use the name of the branch of the push.

  • Optional event?: undefined | string

    Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see "Events that trigger workflows."

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional status?: "completed" | "status" | "conclusion"

    Returns workflow runs associated with the check run status or conclusion you specify. For example, a conclusion can be success or a status can be completed. For more information, see the status and conclusion options available in "Create a check run."

ActionsListWorkflowRunsForRepoRequestOptions

ActionsListWorkflowRunsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs" }

Type declaration

ActionsListWorkflowRunsRequestOptions

ActionsListWorkflowRunsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/workflows/:workflow_id/runs" }

Type declaration

ActionsReRunWorkflowEndpoint

ActionsReRunWorkflowEndpoint: { owner: string; repo: string; run_id: number }

Type declaration

  • owner: string
  • repo: string
  • run_id: number

ActionsReRunWorkflowRequestOptions

ActionsReRunWorkflowRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/actions/runs/:run_id/rerun" }

Type declaration

ActionsRemoveSelectedRepoFromOrgSecretEndpoint

ActionsRemoveSelectedRepoFromOrgSecretEndpoint: { org: string; repository_id: number; secret_name: string }

Type declaration

  • org: string
  • repository_id: number
  • secret_name: string

ActionsRemoveSelectedRepoFromOrgSecretRequestOptions

ActionsRemoveSelectedRepoFromOrgSecretRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/actions/secrets/:secret_name/repositories/:repository_id" }

Type declaration

ActionsSetSelectedReposForOrgSecretEndpoint

ActionsSetSelectedReposForOrgSecretEndpoint: { org: string; secret_name: string; selected_repository_ids?: number[] }

Type declaration

ActionsSetSelectedReposForOrgSecretRequestOptions

ActionsSetSelectedReposForOrgSecretRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/actions/secrets/:secret_name/repositories" }

Type declaration

ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint

ActivityCheckRepoIsStarredByAuthenticatedUserEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions

ActivityCheckRepoIsStarredByAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/starred/:owner/:repo" }

Type declaration

ActivityDeleteRepoSubscriptionEndpoint

ActivityDeleteRepoSubscriptionEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActivityDeleteRepoSubscriptionRequestOptions

ActivityDeleteRepoSubscriptionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/subscription" }

Type declaration

ActivityDeleteThreadSubscriptionEndpoint

ActivityDeleteThreadSubscriptionEndpoint: { thread_id: number }

Type declaration

  • thread_id: number

ActivityDeleteThreadSubscriptionRequestOptions

ActivityDeleteThreadSubscriptionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/notifications/threads/:thread_id/subscription" }

Type declaration

ActivityGetFeedsEndpoint

ActivityGetFeedsEndpoint: {}

Type declaration

ActivityGetFeedsRequestOptions

ActivityGetFeedsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/feeds" }

Type declaration

ActivityGetRepoSubscriptionEndpoint

ActivityGetRepoSubscriptionEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActivityGetRepoSubscriptionRequestOptions

ActivityGetRepoSubscriptionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/subscription" }

Type declaration

ActivityGetThreadEndpoint

ActivityGetThreadEndpoint: { thread_id: number }

Type declaration

  • thread_id: number

ActivityGetThreadRequestOptions

ActivityGetThreadRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/notifications/threads/:thread_id" }

Type declaration

ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint

ActivityGetThreadSubscriptionForAuthenticatedUserEndpoint: { thread_id: number }

Type declaration

  • thread_id: number

ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions

ActivityGetThreadSubscriptionForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/notifications/threads/:thread_id/subscription" }

Type declaration

ActivityListEventsForAuthenticatedUserEndpoint

ActivityListEventsForAuthenticatedUserEndpoint: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListEventsForAuthenticatedUserRequestOptions

ActivityListEventsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/events" }

Type declaration

ActivityListNotificationsForAuthenticatedUserEndpoint

ActivityListNotificationsForAuthenticatedUserEndpoint: { all?: undefined | false | true; before?: undefined | string; page?: undefined | number; participating?: undefined | false | true; per_page?: undefined | number; since?: undefined | string }

Type declaration

  • Optional all?: undefined | false | true

    If true, show notifications marked as read.

  • Optional before?: undefined | string

    Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional participating?: undefined | false | true

    If true, only shows notifications in which the user is directly participating or mentioned.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ActivityListNotificationsForAuthenticatedUserRequestOptions

ActivityListNotificationsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/notifications" }

Type declaration

ActivityListNotificationsForAuthenticatedUserResponseData

ActivityListNotificationsForAuthenticatedUserResponseData: { id: string; last_read_at: string; reason: string; repository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }; subject: { latest_comment_url: string; title: string; type: string; url: string }; unread: boolean; updated_at: string; url: string }[]

ActivityListOrgEventsForAuthenticatedUserEndpoint

ActivityListOrgEventsForAuthenticatedUserEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListOrgEventsForAuthenticatedUserRequestOptions

ActivityListOrgEventsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/events/orgs/:org" }

Type declaration

ActivityListPublicEventsEndpoint

ActivityListPublicEventsEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ActivityListPublicEventsForRepoNetworkEndpoint

ActivityListPublicEventsForRepoNetworkEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActivityListPublicEventsForRepoNetworkRequestOptions

ActivityListPublicEventsForRepoNetworkRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/networks/:owner/:repo/events" }

Type declaration

ActivityListPublicEventsForUserEndpoint

ActivityListPublicEventsForUserEndpoint: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListPublicEventsForUserRequestOptions

ActivityListPublicEventsForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/events/public" }

Type declaration

ActivityListPublicEventsRequestOptions

ActivityListPublicEventsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/events" }

Type declaration

ActivityListPublicOrgEventsEndpoint

ActivityListPublicOrgEventsEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ActivityListPublicOrgEventsRequestOptions

ActivityListPublicOrgEventsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/events" }

Type declaration

ActivityListReceivedEventsForUserEndpoint

ActivityListReceivedEventsForUserEndpoint: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListReceivedEventsForUserRequestOptions

ActivityListReceivedEventsForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/received_events" }

Type declaration

ActivityListReceivedPublicEventsForUserEndpoint

ActivityListReceivedPublicEventsForUserEndpoint: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListReceivedPublicEventsForUserRequestOptions

ActivityListReceivedPublicEventsForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/received_events/public" }

Type declaration

ActivityListRepoEventsEndpoint

ActivityListRepoEventsEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActivityListRepoEventsRequestOptions

ActivityListRepoEventsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/events" }

Type declaration

ActivityListRepoNotificationsForAuthenticatedUserEndpoint

ActivityListRepoNotificationsForAuthenticatedUserEndpoint: { all?: undefined | false | true; before?: undefined | string; owner: string; page?: undefined | number; participating?: undefined | false | true; per_page?: undefined | number; repo: string; since?: undefined | string }

Type declaration

  • Optional all?: undefined | false | true

    If true, show notifications marked as read.

  • Optional before?: undefined | string

    Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional participating?: undefined | false | true

    If true, only shows notifications in which the user is directly participating or mentioned.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional since?: undefined | string

    Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ActivityListRepoNotificationsForAuthenticatedUserRequestOptions

ActivityListRepoNotificationsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/notifications" }

Type declaration

ActivityListRepoNotificationsForAuthenticatedUserResponseData

ActivityListRepoNotificationsForAuthenticatedUserResponseData: { id: string; last_read_at: string; reason: string; repository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }; subject: { latest_comment_url: string; title: string; type: string; url: string }; unread: boolean; updated_at: string; url: string }[]

ActivityListReposStarredByAuthenticatedUserEndpoint

ActivityListReposStarredByAuthenticatedUserEndpoint: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    One of asc (ascending) or desc (descending).

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional sort?: "created" | "updated"

    One of created (when the repository was starred) or updated (when it was last pushed to).

ActivityListReposStarredByAuthenticatedUserRequestOptions

ActivityListReposStarredByAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/starred" }

Type declaration

ActivityListReposStarredByAuthenticatedUserResponse200Data

ActivityListReposStarredByAuthenticatedUserResponse200Data: { repo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }; starred_at: string }[]

ActivityListReposStarredByAuthenticatedUserResponseData

ActivityListReposStarredByAuthenticatedUserResponseData: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }[]

ActivityListReposStarredByUserEndpoint

ActivityListReposStarredByUserEndpoint: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; sort?: "created" | "updated"; username: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    One of asc (ascending) or desc (descending).

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional sort?: "created" | "updated"

    One of created (when the repository was starred) or updated (when it was last pushed to).

  • username: string

ActivityListReposStarredByUserRequestOptions

ActivityListReposStarredByUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/starred" }

Type declaration

ActivityListReposStarredByUserResponse200Data

ActivityListReposStarredByUserResponse200Data: { repo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }; starred_at: string }[]

ActivityListReposStarredByUserResponseData

ActivityListReposStarredByUserResponseData: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }[]

ActivityListReposWatchedByUserEndpoint

ActivityListReposWatchedByUserEndpoint: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

ActivityListReposWatchedByUserRequestOptions

ActivityListReposWatchedByUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/subscriptions" }

Type declaration

ActivityListReposWatchedByUserResponseData

ActivityListReposWatchedByUserResponseData: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; license: { key: string; name: string; node_id: string; spdx_id: string; url: string }; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }[]

ActivityListStargazersForRepoEndpoint

ActivityListStargazersForRepoEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActivityListStargazersForRepoRequestOptions

ActivityListStargazersForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/stargazers" }

Type declaration

ActivityListStargazersForRepoResponse200Data

ActivityListStargazersForRepoResponse200Data: { starred_at: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

ActivityListStargazersForRepoResponseData

ActivityListStargazersForRepoResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

ActivityListWatchedReposForAuthenticatedUserEndpoint

ActivityListWatchedReposForAuthenticatedUserEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ActivityListWatchedReposForAuthenticatedUserRequestOptions

ActivityListWatchedReposForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/subscriptions" }

Type declaration

ActivityListWatchedReposForAuthenticatedUserResponseData

ActivityListWatchedReposForAuthenticatedUserResponseData: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; license: { key: string; name: string; node_id: string; spdx_id: string; url: string }; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }[]

ActivityListWatchersForRepoEndpoint

ActivityListWatchersForRepoEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ActivityListWatchersForRepoRequestOptions

ActivityListWatchersForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/subscribers" }

Type declaration

ActivityListWatchersForRepoResponseData

ActivityListWatchersForRepoResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

ActivityMarkNotificationsAsReadEndpoint

ActivityMarkNotificationsAsReadEndpoint: { last_read_at?: undefined | string }

Type declaration

  • Optional last_read_at?: undefined | string

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

ActivityMarkNotificationsAsReadRequestOptions

ActivityMarkNotificationsAsReadRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/notifications" }

Type declaration

ActivityMarkRepoNotificationsAsReadEndpoint

ActivityMarkRepoNotificationsAsReadEndpoint: { last_read_at?: undefined | string; owner: string; repo: string }

Type declaration

  • Optional last_read_at?: undefined | string

    Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: The current timestamp.

  • owner: string
  • repo: string

ActivityMarkRepoNotificationsAsReadRequestOptions

ActivityMarkRepoNotificationsAsReadRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/notifications" }

Type declaration

ActivityMarkThreadAsReadEndpoint

ActivityMarkThreadAsReadEndpoint: { thread_id: number }

Type declaration

  • thread_id: number

ActivityMarkThreadAsReadRequestOptions

ActivityMarkThreadAsReadRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/notifications/threads/:thread_id" }

Type declaration

ActivitySetRepoSubscriptionEndpoint

ActivitySetRepoSubscriptionEndpoint: { ignored?: undefined | false | true; owner: string; repo: string; subscribed?: undefined | false | true }

Type declaration

  • Optional ignored?: undefined | false | true

    Determines if all notifications should be blocked from this repository.

  • owner: string
  • repo: string
  • Optional subscribed?: undefined | false | true

    Determines if notifications should be received from this repository.

ActivitySetRepoSubscriptionRequestOptions

ActivitySetRepoSubscriptionRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/subscription" }

Type declaration

ActivitySetThreadSubscriptionEndpoint

ActivitySetThreadSubscriptionEndpoint: { ignored?: undefined | false | true; thread_id: number }

Type declaration

  • Optional ignored?: undefined | false | true

    Unsubscribes and subscribes you to a conversation. Set ignored to true to block all notifications from this thread.

  • thread_id: number

ActivitySetThreadSubscriptionRequestOptions

ActivitySetThreadSubscriptionRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/notifications/threads/:thread_id/subscription" }

Type declaration

ActivityStarRepoForAuthenticatedUserEndpoint

ActivityStarRepoForAuthenticatedUserEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActivityStarRepoForAuthenticatedUserRequestOptions

ActivityStarRepoForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/user/starred/:owner/:repo" }

Type declaration

ActivityUnstarRepoForAuthenticatedUserEndpoint

ActivityUnstarRepoForAuthenticatedUserEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ActivityUnstarRepoForAuthenticatedUserRequestOptions

ActivityUnstarRepoForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/starred/:owner/:repo" }

Type declaration

AppsAddRepoToInstallationEndpoint

AppsAddRepoToInstallationEndpoint: { installation_id: number; repository_id: number } & RequiredPreview<"machine-man">

AppsAddRepoToInstallationRequestOptions

AppsAddRepoToInstallationRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/user/installations/:installation_id/repositories/:repository_id" }

Type declaration

AppsCheckAuthorizationEndpoint

AppsCheckAuthorizationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string
  • client_id: string

AppsCheckAuthorizationRequestOptions

AppsCheckAuthorizationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/applications/:client_id/tokens/:access_token" }

Type declaration

AppsCheckTokenEndpoint

AppsCheckTokenEndpoint: { access_token?: undefined | string; client_id: string }

Type declaration

  • Optional access_token?: undefined | string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

AppsCheckTokenRequestOptions

AppsCheckTokenRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/applications/:client_id/token" }

Type declaration

AppsCreateContentAttachmentEndpoint

AppsCreateContentAttachmentEndpoint: { body: string; content_reference_id: number; title: string } & RequiredPreview<"corsair">

AppsCreateContentAttachmentRequestOptions

AppsCreateContentAttachmentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/content_references/:content_reference_id/attachments" }

Type declaration

AppsCreateFromManifestEndpoint

AppsCreateFromManifestEndpoint: { code: string }

Type declaration

  • code: string

AppsCreateFromManifestRequestOptions

AppsCreateFromManifestRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/app-manifests/:code/conversions" }

Type declaration

AppsCreateInstallationAccessTokenEndpoint

AppsCreateInstallationAccessTokenEndpoint: { installation_id: number; permissions?: AppsCreateInstallationAccessTokenParamsPermissions; repository_ids?: number[] } & RequiredPreview<"machine-man">

AppsCreateInstallationAccessTokenParamsPermissions

AppsCreateInstallationAccessTokenParamsPermissions: {}

Type declaration

AppsCreateInstallationAccessTokenParamsPermissionsKeyString

AppsCreateInstallationAccessTokenParamsPermissionsKeyString: {}

Type declaration

AppsCreateInstallationAccessTokenRequestOptions

AppsCreateInstallationAccessTokenRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/app/installations/:installation_id/access_tokens" }

Type declaration

AppsDeleteAuthorizationEndpoint

AppsDeleteAuthorizationEndpoint: { access_token?: undefined | string; client_id: string }

Type declaration

  • Optional access_token?: undefined | string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

AppsDeleteAuthorizationRequestOptions

AppsDeleteAuthorizationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/applications/:client_id/grant" }

Type declaration

AppsDeleteInstallationEndpoint

AppsDeleteInstallationEndpoint: { installation_id: number } & RequiredPreview<"machine-man">

AppsDeleteInstallationRequestOptions

AppsDeleteInstallationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/app/installations/:installation_id" }

Type declaration

AppsDeleteTokenEndpoint

AppsDeleteTokenEndpoint: { access_token?: undefined | string; client_id: string }

Type declaration

  • Optional access_token?: undefined | string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

AppsDeleteTokenRequestOptions

AppsDeleteTokenRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/applications/:client_id/token" }

Type declaration

AppsGetAuthenticatedEndpoint

AppsGetAuthenticatedEndpoint: {} & RequiredPreview<"machine-man">

AppsGetAuthenticatedRequestOptions

AppsGetAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/app" }

Type declaration

AppsGetBySlugEndpoint

AppsGetBySlugEndpoint: { app_slug: string } & RequiredPreview<"machine-man">

AppsGetBySlugRequestOptions

AppsGetBySlugRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/apps/:app_slug" }

Type declaration

AppsGetInstallationEndpoint

AppsGetInstallationEndpoint: { installation_id: number } & RequiredPreview<"machine-man">

AppsGetInstallationRequestOptions

AppsGetInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/app/installations/:installation_id" }

Type declaration

AppsGetOrgInstallationEndpoint

AppsGetOrgInstallationEndpoint: { org: string } & RequiredPreview<"machine-man">

AppsGetOrgInstallationRequestOptions

AppsGetOrgInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/installation" }

Type declaration

AppsGetRepoInstallationEndpoint

AppsGetRepoInstallationEndpoint: { owner: string; repo: string } & RequiredPreview<"machine-man">

AppsGetRepoInstallationRequestOptions

AppsGetRepoInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/installation" }

Type declaration

AppsGetSubscriptionPlanForAccountEndpoint

AppsGetSubscriptionPlanForAccountEndpoint: { account_id: number }

Type declaration

  • account_id: number

AppsGetSubscriptionPlanForAccountRequestOptions

AppsGetSubscriptionPlanForAccountRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/marketplace_listing/accounts/:account_id" }

Type declaration

AppsGetSubscriptionPlanForAccountStubbedEndpoint

AppsGetSubscriptionPlanForAccountStubbedEndpoint: { account_id: number }

Type declaration

  • account_id: number

AppsGetSubscriptionPlanForAccountStubbedRequestOptions

AppsGetSubscriptionPlanForAccountStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/marketplace_listing/stubbed/accounts/:account_id" }

Type declaration

AppsGetUserInstallationEndpoint

AppsGetUserInstallationEndpoint: { username: string } & RequiredPreview<"machine-man">

AppsGetUserInstallationRequestOptions

AppsGetUserInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/installation" }

Type declaration

AppsListAccountsForPlanEndpoint

AppsListAccountsForPlanEndpoint: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; plan_id: number; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • plan_id: number
  • Optional sort?: "created" | "updated"

    Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.

AppsListAccountsForPlanRequestOptions

AppsListAccountsForPlanRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/marketplace_listing/plans/:plan_id/accounts" }

Type declaration

AppsListAccountsForPlanResponseData

AppsListAccountsForPlanResponseData: { email: string; id: number; login: string; marketplace_pending_change: { effective_date: string; id: number; plan: { accounts_url: string; bullets: string[]; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: string; url: string; yearly_price_in_cents: number }; unit_count: number }; marketplace_purchase: { billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: { accounts_url: string; bullets: string[]; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: string; url: string; yearly_price_in_cents: number }; unit_count: number; updated_at: string }; organization_billing_email: string; type: string; url: string }[]

AppsListAccountsForPlanStubbedEndpoint

AppsListAccountsForPlanStubbedEndpoint: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; plan_id: number; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    To return the oldest accounts first, set to asc. Can be one of asc or desc. Ignored without the sort parameter.

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • plan_id: number
  • Optional sort?: "created" | "updated"

    Sorts the GitHub accounts by the date they were created or last updated. Can be one of created or updated.

AppsListAccountsForPlanStubbedRequestOptions

AppsListAccountsForPlanStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/marketplace_listing/stubbed/plans/:plan_id/accounts" }

Type declaration

AppsListAccountsForPlanStubbedResponseData

AppsListAccountsForPlanStubbedResponseData: { email: string; id: number; login: string; marketplace_pending_change: { effective_date: string; id: number; plan: { accounts_url: string; bullets: string[]; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: string; url: string; yearly_price_in_cents: number }; unit_count: number }; marketplace_purchase: { billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: { accounts_url: string; bullets: string[]; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: string; url: string; yearly_price_in_cents: number }; unit_count: number; updated_at: string }; organization_billing_email: string; type: string; url: string }[]

AppsListInstallationReposForAuthenticatedUserEndpoint

AppsListInstallationReposForAuthenticatedUserEndpoint: { installation_id: number; page?: undefined | number; per_page?: undefined | number } & RequiredPreview<"machine-man">

AppsListInstallationReposForAuthenticatedUserRequestOptions

AppsListInstallationReposForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/installations/:installation_id/repositories" }

Type declaration

AppsListInstallationsEndpoint

AppsListInstallationsEndpoint: { page?: undefined | number; per_page?: undefined | number } & RequiredPreview<"machine-man">

AppsListInstallationsForAuthenticatedUserEndpoint

AppsListInstallationsForAuthenticatedUserEndpoint: { page?: undefined | number; per_page?: undefined | number } & RequiredPreview<"machine-man">

AppsListInstallationsForAuthenticatedUserRequestOptions

AppsListInstallationsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/installations" }

Type declaration

AppsListInstallationsRequestOptions

AppsListInstallationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/app/installations" }

Type declaration

AppsListInstallationsResponseData

AppsListInstallationsResponseData: { access_tokens_url: string; account: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }; app_id: number; events: string[]; html_url: string; id: number; permissions: { checks: string; contents: string; metadata: string }; repositories_url: string; repository_selection: "all" | "selected"; single_file_name: string; target_id: number; target_type: string }[]

AppsListPlansEndpoint

AppsListPlansEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsListPlansRequestOptions

AppsListPlansRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/marketplace_listing/plans" }

Type declaration

AppsListPlansResponseData

AppsListPlansResponseData: { accounts_url: string; bullets: string[]; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: string; url: string; yearly_price_in_cents: number }[]

AppsListPlansStubbedEndpoint

AppsListPlansStubbedEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsListPlansStubbedRequestOptions

AppsListPlansStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/marketplace_listing/stubbed/plans" }

Type declaration

AppsListPlansStubbedResponseData

AppsListPlansStubbedResponseData: { accounts_url: string; bullets: string[]; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: string; url: string; yearly_price_in_cents: number }[]

AppsListReposAccessibleToInstallationEndpoint

AppsListReposAccessibleToInstallationEndpoint: { page?: undefined | number; per_page?: undefined | number } & RequiredPreview<"machine-man">

AppsListReposAccessibleToInstallationRequestOptions

AppsListReposAccessibleToInstallationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/installation/repositories" }

Type declaration

AppsListSubscriptionsForAuthenticatedUserEndpoint

AppsListSubscriptionsForAuthenticatedUserEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsListSubscriptionsForAuthenticatedUserRequestOptions

AppsListSubscriptionsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/marketplace_purchases" }

Type declaration

AppsListSubscriptionsForAuthenticatedUserResponseData

AppsListSubscriptionsForAuthenticatedUserResponseData: { account: { email: string; id: number; login: string; organization_billing_email: string; type: string; url: string }; billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: { accounts_url: string; bullets: string[]; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: string; url: string; yearly_price_in_cents: number }; unit_count: number; updated_at: string }[]

AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint

AppsListSubscriptionsForAuthenticatedUserStubbedEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions

AppsListSubscriptionsForAuthenticatedUserStubbedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/marketplace_purchases/stubbed" }

Type declaration

AppsListSubscriptionsForAuthenticatedUserStubbedResponseData

AppsListSubscriptionsForAuthenticatedUserStubbedResponseData: { account: { email: string; id: number; login: string; organization_billing_email: string; type: string; url: string }; billing_cycle: string; free_trial_ends_on: string; next_billing_date: string; on_free_trial: boolean; plan: { accounts_url: string; bullets: string[]; description: string; has_free_trial: boolean; id: number; monthly_price_in_cents: number; name: string; number: number; price_model: string; state: string; unit_name: string; url: string; yearly_price_in_cents: number }; unit_count: number; updated_at: string }[]

AppsRemoveRepoFromInstallationEndpoint

AppsRemoveRepoFromInstallationEndpoint: { installation_id: number; repository_id: number } & RequiredPreview<"machine-man">

AppsRemoveRepoFromInstallationRequestOptions

AppsRemoveRepoFromInstallationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/installations/:installation_id/repositories/:repository_id" }

Type declaration

AppsResetAuthorizationEndpoint

AppsResetAuthorizationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string
  • client_id: string

AppsResetAuthorizationRequestOptions

AppsResetAuthorizationRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/applications/:client_id/tokens/:access_token" }

Type declaration

AppsResetTokenEndpoint

AppsResetTokenEndpoint: { access_token?: undefined | string; client_id: string }

Type declaration

  • Optional access_token?: undefined | string

    The OAuth access token used to authenticate to the GitHub API.

  • client_id: string

AppsResetTokenRequestOptions

AppsResetTokenRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/applications/:client_id/token" }

Type declaration

AppsRevokeAuthorizationForApplicationEndpoint

AppsRevokeAuthorizationForApplicationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string
  • client_id: string

AppsRevokeAuthorizationForApplicationRequestOptions

AppsRevokeAuthorizationForApplicationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/applications/:client_id/tokens/:access_token" }

Type declaration

AppsRevokeGrantForApplicationEndpoint

AppsRevokeGrantForApplicationEndpoint: { access_token: string; client_id: string }

Type declaration

  • access_token: string
  • client_id: string

AppsRevokeGrantForApplicationRequestOptions

AppsRevokeGrantForApplicationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/applications/:client_id/grants/:access_token" }

Type declaration

AppsRevokeInstallationAccessTokenEndpoint

AppsRevokeInstallationAccessTokenEndpoint: {}

Type declaration

AppsRevokeInstallationAccessTokenRequestOptions

AppsRevokeInstallationAccessTokenRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/installation/token" }

Type declaration

AppsSuspendInstallationEndpoint

AppsSuspendInstallationEndpoint: { installation_id: number }

Type declaration

  • installation_id: number

AppsSuspendInstallationRequestOptions

AppsSuspendInstallationRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/app/installations/:installation_id/suspended" }

Type declaration

AppsUnsuspendInstallationEndpoint

AppsUnsuspendInstallationEndpoint: { installation_id: number }

Type declaration

  • installation_id: number

AppsUnsuspendInstallationRequestOptions

AppsUnsuspendInstallationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/app/installations/:installation_id/suspended" }

Type declaration

BillingGetGithubActionsBillingGheEndpoint

BillingGetGithubActionsBillingGheEndpoint: { enterprise_id: number }

Type declaration

  • enterprise_id: number

    Unique identifier of the GitHub Enterprise Cloud instance.

BillingGetGithubActionsBillingGheRequestOptions

BillingGetGithubActionsBillingGheRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/enterprises/:enterprise_id/settings/billing/actions" }

Type declaration

BillingGetGithubActionsBillingOrgEndpoint

BillingGetGithubActionsBillingOrgEndpoint: { org: string }

Type declaration

  • org: string

BillingGetGithubActionsBillingOrgRequestOptions

BillingGetGithubActionsBillingOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/settings/billing/actions" }

Type declaration

BillingGetGithubActionsBillingUserEndpoint

BillingGetGithubActionsBillingUserEndpoint: { username: string }

Type declaration

  • username: string

BillingGetGithubActionsBillingUserRequestOptions

BillingGetGithubActionsBillingUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/settings/billing/actions" }

Type declaration

BillingGetGithubPackagesBillingGheEndpoint

BillingGetGithubPackagesBillingGheEndpoint: { enterprise_id: number }

Type declaration

  • enterprise_id: number

    Unique identifier of the GitHub Enterprise Cloud instance.

BillingGetGithubPackagesBillingGheRequestOptions

BillingGetGithubPackagesBillingGheRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/enterprises/:enterprise_id/settings/billing/packages" }

Type declaration

BillingGetGithubPackagesBillingOrgEndpoint

BillingGetGithubPackagesBillingOrgEndpoint: { org: string }

Type declaration

  • org: string

BillingGetGithubPackagesBillingOrgRequestOptions

BillingGetGithubPackagesBillingOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/settings/billing/packages" }

Type declaration

BillingGetGithubPackagesBillingUserEndpoint

BillingGetGithubPackagesBillingUserEndpoint: { username: string }

Type declaration

  • username: string

BillingGetGithubPackagesBillingUserRequestOptions

BillingGetGithubPackagesBillingUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/settings/billing/packages" }

Type declaration

BillingGetSharedStorageBillingGheEndpoint

BillingGetSharedStorageBillingGheEndpoint: { enterprise_id: number }

Type declaration

  • enterprise_id: number

    Unique identifier of the GitHub Enterprise Cloud instance.

BillingGetSharedStorageBillingGheRequestOptions

BillingGetSharedStorageBillingGheRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/enterprises/:enterprise_id/settings/billing/shared-storage" }

Type declaration

BillingGetSharedStorageBillingOrgEndpoint

BillingGetSharedStorageBillingOrgEndpoint: { org: string }

Type declaration

  • org: string

BillingGetSharedStorageBillingOrgRequestOptions

BillingGetSharedStorageBillingOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/settings/billing/shared-storage" }

Type declaration

BillingGetSharedStorageBillingUserEndpoint

BillingGetSharedStorageBillingUserEndpoint: { username: string }

Type declaration

  • username: string

BillingGetSharedStorageBillingUserRequestOptions

BillingGetSharedStorageBillingUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/settings/billing/shared-storage" }

Type declaration

ChecksCreateEndpoint

ChecksCreateEndpoint: { actions?: ChecksCreateParamsActions[]; completed_at?: undefined | string; conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required"; details_url?: undefined | string; external_id?: undefined | string; head_sha: string; name: string; output?: ChecksCreateParamsOutput; owner: string; repo: string; started_at?: undefined | string; status?: "queued" | "in_progress" | "completed" } & RequiredPreview<"antiope">

ChecksCreateParamsActions

ChecksCreateParamsActions: { description: string; identifier: string; label: string }

Type declaration

  • description: string
  • identifier: string
  • label: string

ChecksCreateParamsOutput

ChecksCreateParamsOutput: { annotations?: ChecksCreateParamsOutputAnnotations[]; images?: ChecksCreateParamsOutputImages[]; summary: string; text?: undefined | string; title: string }

Type declaration

ChecksCreateParamsOutputAnnotations

ChecksCreateParamsOutputAnnotations: { annotation_level: "notice" | "warning" | "failure"; end_column?: undefined | number; end_line: number; message: string; path: string; raw_details?: undefined | string; start_column?: undefined | number; start_line: number; title?: undefined | string }

Type declaration

  • annotation_level: "notice" | "warning" | "failure"
  • Optional end_column?: undefined | number
  • end_line: number
  • message: string
  • path: string
  • Optional raw_details?: undefined | string
  • Optional start_column?: undefined | number
  • start_line: number
  • Optional title?: undefined | string

ChecksCreateParamsOutputImages

ChecksCreateParamsOutputImages: { alt: string; caption?: undefined | string; image_url: string }

Type declaration

  • alt: string
  • Optional caption?: undefined | string
  • image_url: string

ChecksCreateRequestOptions

ChecksCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-runs" }

Type declaration

ChecksCreateSuiteEndpoint

ChecksCreateSuiteEndpoint: { head_sha: string; owner: string; repo: string } & RequiredPreview<"antiope">

ChecksCreateSuiteRequestOptions

ChecksCreateSuiteRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-suites" }

Type declaration

ChecksGetEndpoint

ChecksGetEndpoint: { check_run_id: number; owner: string; repo: string } & RequiredPreview<"antiope">

ChecksGetRequestOptions

ChecksGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-runs/:check_run_id" }

Type declaration

ChecksGetSuiteEndpoint

ChecksGetSuiteEndpoint: { check_suite_id: number; owner: string; repo: string } & RequiredPreview<"antiope">

ChecksGetSuiteRequestOptions

ChecksGetSuiteRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-suites/:check_suite_id" }

Type declaration

ChecksListAnnotationsEndpoint

ChecksListAnnotationsEndpoint: { check_run_id: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string } & RequiredPreview<"antiope">

ChecksListAnnotationsRequestOptions

ChecksListAnnotationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-runs/:check_run_id/annotations" }

Type declaration

ChecksListAnnotationsResponseData

ChecksListAnnotationsResponseData: { annotation_level: string; end_column: number; end_line: number; message: string; path: string; raw_details: string; start_column: number; start_line: number; title: string }[]

ChecksListForRefEndpoint

ChecksListForRefEndpoint: { check_name?: undefined | string; filter?: "latest" | "all"; owner: string; page?: undefined | number; per_page?: undefined | number; ref: string; repo: string; status?: "queued" | "in_progress" | "completed" } & RequiredPreview<"antiope">

ChecksListForRefRequestOptions

ChecksListForRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:ref/check-runs" }

Type declaration

ChecksListForSuiteEndpoint

ChecksListForSuiteEndpoint: { check_name?: undefined | string; check_suite_id: number; filter?: "latest" | "all"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; status?: "queued" | "in_progress" | "completed" } & RequiredPreview<"antiope">

ChecksListForSuiteRequestOptions

ChecksListForSuiteRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs" }

Type declaration

ChecksListSuitesForRefEndpoint

ChecksListSuitesForRefEndpoint: { app_id?: undefined | number; check_name?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; ref: string; repo: string } & RequiredPreview<"antiope">

ChecksListSuitesForRefRequestOptions

ChecksListSuitesForRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:ref/check-suites" }

Type declaration

ChecksRerequestSuiteEndpoint

ChecksRerequestSuiteEndpoint: { check_suite_id: number; owner: string; repo: string } & RequiredPreview<"antiope">

ChecksRerequestSuiteRequestOptions

ChecksRerequestSuiteRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest" }

Type declaration

ChecksSetSuitesPreferencesEndpoint

ChecksSetSuitesPreferencesEndpoint: { auto_trigger_checks?: ChecksSetSuitesPreferencesParamsAutoTriggerChecks[]; owner: string; repo: string } & RequiredPreview<"antiope">

ChecksSetSuitesPreferencesParamsAutoTriggerChecks

ChecksSetSuitesPreferencesParamsAutoTriggerChecks: { app_id: number; setting: boolean }

Type declaration

  • app_id: number
  • setting: boolean

ChecksSetSuitesPreferencesRequestOptions

ChecksSetSuitesPreferencesRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-suites/preferences" }

Type declaration

ChecksUpdateEndpoint

ChecksUpdateEndpoint: { actions?: ChecksUpdateParamsActions[]; check_run_id: number; completed_at?: undefined | string; conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required"; details_url?: undefined | string; external_id?: undefined | string; name?: undefined | string; output?: ChecksUpdateParamsOutput; owner: string; repo: string; started_at?: undefined | string; status?: "queued" | "in_progress" | "completed" } & RequiredPreview<"antiope">

ChecksUpdateParamsActions

ChecksUpdateParamsActions: { description: string; identifier: string; label: string }

Type declaration

  • description: string
  • identifier: string
  • label: string

ChecksUpdateParamsOutput

ChecksUpdateParamsOutput: { annotations?: ChecksUpdateParamsOutputAnnotations[]; images?: ChecksUpdateParamsOutputImages[]; summary: string; text?: undefined | string; title?: undefined | string }

Type declaration

ChecksUpdateParamsOutputAnnotations

ChecksUpdateParamsOutputAnnotations: { annotation_level: "notice" | "warning" | "failure"; end_column?: undefined | number; end_line: number; message: string; path: string; raw_details?: undefined | string; start_column?: undefined | number; start_line: number; title?: undefined | string }

Type declaration

  • annotation_level: "notice" | "warning" | "failure"
  • Optional end_column?: undefined | number
  • end_line: number
  • message: string
  • path: string
  • Optional raw_details?: undefined | string
  • Optional start_column?: undefined | number
  • start_line: number
  • Optional title?: undefined | string

ChecksUpdateParamsOutputImages

ChecksUpdateParamsOutputImages: { alt: string; caption?: undefined | string; image_url: string }

Type declaration

  • alt: string
  • Optional caption?: undefined | string
  • image_url: string

ChecksUpdateRequestOptions

ChecksUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/check-runs/:check_run_id" }

Type declaration

CodeScanningGetAlertEndpoint

CodeScanningGetAlertEndpoint: { alert_id: number; owner: string; repo: string }

Type declaration

  • alert_id: number
  • owner: string
  • repo: string

CodeScanningGetAlertRequestOptions

CodeScanningGetAlertRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/code-scanning/alerts/:alert_id" }

Type declaration

CodeScanningListAlertsForRepoEndpoint

CodeScanningListAlertsForRepoEndpoint: { owner: string; ref?: undefined | string; repo: string; state?: undefined | string }

Type declaration

  • owner: string
  • Optional ref?: undefined | string

    Returns a list of code scanning alerts for a specific brach reference. The ref must be formatted as heads/<branch name>.

  • repo: string
  • Optional state?: undefined | string

    Set to closed to list only closed code scanning alerts.

CodeScanningListAlertsForRepoRequestOptions

CodeScanningListAlertsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/code-scanning/alerts" }

Type declaration

CodeScanningListAlertsForRepoResponseData

CodeScanningListAlertsForRepoResponseData: { closed_at: string; closed_by: string; created_at: string; html_url: string; open: boolean; rule_description: string; rule_id: string; rule_severity: string; tool: string; url: string }[]

CodesOfConductGetAllCodesOfConductEndpoint

CodesOfConductGetAllCodesOfConductEndpoint: {} & RequiredPreview<"scarlet-witch">

CodesOfConductGetAllCodesOfConductRequestOptions

CodesOfConductGetAllCodesOfConductRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/codes_of_conduct" }

Type declaration

CodesOfConductGetAllCodesOfConductResponseData

CodesOfConductGetAllCodesOfConductResponseData: { key: string; name: string; url: string }[]

CodesOfConductGetConductCodeEndpoint

CodesOfConductGetConductCodeEndpoint: { key: string } & RequiredPreview<"scarlet-witch">

CodesOfConductGetConductCodeRequestOptions

CodesOfConductGetConductCodeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/codes_of_conduct/:key" }

Type declaration

CodesOfConductGetForRepoEndpoint

CodesOfConductGetForRepoEndpoint: { owner: string; repo: string } & RequiredPreview<"scarlet-witch">

CodesOfConductGetForRepoRequestOptions

CodesOfConductGetForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/community/code_of_conduct" }

Type declaration

EmojisGetEndpoint

EmojisGetEndpoint: {}

Type declaration

EmojisGetRequestOptions

EmojisGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/emojis" }

Type declaration

EnterpriseAdminDeleteScimGroupFromEnterpriseEndpoint

EnterpriseAdminDeleteScimGroupFromEnterpriseEndpoint: { enterprise: string; scim_group_id: string }

Type declaration

  • enterprise: string
  • scim_group_id: string

    Identifier generated by the GitHub SCIM endpoint.

EnterpriseAdminDeleteScimGroupFromEnterpriseRequestOptions

EnterpriseAdminDeleteScimGroupFromEnterpriseRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/scim/v2/enterprises/:enterprise/Groups/:scim_group_id" }

Type declaration

EnterpriseAdminDeleteUserFromEnterpriseEndpoint

EnterpriseAdminDeleteUserFromEnterpriseEndpoint: { enterprise: string; scim_user_id: string }

Type declaration

  • enterprise: string
  • scim_user_id: string

    Identifier generated by the GitHub SCIM endpoint.

EnterpriseAdminDeleteUserFromEnterpriseRequestOptions

EnterpriseAdminDeleteUserFromEnterpriseRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/scim/v2/enterprises/:enterprise/Users/:scim_user_id" }

Type declaration

EnterpriseAdminGetProvisioningInformationForEnterpriseGroupEndpoint

EnterpriseAdminGetProvisioningInformationForEnterpriseGroupEndpoint: { enterprise: string; scim_group_id: string }

Type declaration

  • enterprise: string
  • scim_group_id: string

    Identifier generated by the GitHub SCIM endpoint.

EnterpriseAdminGetProvisioningInformationForEnterpriseGroupRequestOptions

EnterpriseAdminGetProvisioningInformationForEnterpriseGroupRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/scim/v2/enterprises/:enterprise/Groups/:scim_group_id" }

Type declaration

EnterpriseAdminGetProvisioningInformationForEnterpriseUserEndpoint

EnterpriseAdminGetProvisioningInformationForEnterpriseUserEndpoint: { enterprise: string; scim_user_id: string }

Type declaration

  • enterprise: string
  • scim_user_id: string

    Identifier generated by the GitHub SCIM endpoint.

EnterpriseAdminGetProvisioningInformationForEnterpriseUserRequestOptions

EnterpriseAdminGetProvisioningInformationForEnterpriseUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/scim/v2/enterprises/:enterprise/Users/:scim_user_id" }

Type declaration

EnterpriseAdminListProvisionedGroupsEnterpriseEndpoint

EnterpriseAdminListProvisionedGroupsEnterpriseEndpoint: { count?: undefined | number; enterprise: string; startIndex?: undefined | number }

Type declaration

  • Optional count?: undefined | number

    Used for pagination: the number of results to return.

  • enterprise: string
  • Optional startIndex?: undefined | number

    Used for pagination: the index of the first result to return.

EnterpriseAdminListProvisionedGroupsEnterpriseRequestOptions

EnterpriseAdminListProvisionedGroupsEnterpriseRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/scim/v2/enterprises/:enterprise/Groups" }

Type declaration

EnterpriseAdminListProvisionedIdentitiesEnterpriseEndpoint

EnterpriseAdminListProvisionedIdentitiesEnterpriseEndpoint: { count?: undefined | number; enterprise: string; startIndex?: undefined | number }

Type declaration

  • Optional count?: undefined | number

    Used for pagination: the number of results to return.

  • enterprise: string
  • Optional startIndex?: undefined | number

    Used for pagination: the index of the first result to return.

EnterpriseAdminListProvisionedIdentitiesEnterpriseRequestOptions

EnterpriseAdminListProvisionedIdentitiesEnterpriseRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/scim/v2/enterprises/:enterprise/Users" }

Type declaration

EnterpriseAdminProvisionAndInviteEnterpriseGroupEndpoint

EnterpriseAdminProvisionAndInviteEnterpriseGroupEndpoint: { displayName: string; enterprise: string; members?: EnterpriseAdminProvisionAndInviteEnterpriseGroupParamsMembers[]; schemas: string[] }

Type declaration

EnterpriseAdminProvisionAndInviteEnterpriseGroupParamsMembers

EnterpriseAdminProvisionAndInviteEnterpriseGroupParamsMembers: { value: string }

Type declaration

  • value: string

EnterpriseAdminProvisionAndInviteEnterpriseGroupRequestOptions

EnterpriseAdminProvisionAndInviteEnterpriseGroupRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/scim/v2/enterprises/:enterprise/Groups" }

Type declaration

EnterpriseAdminProvisionAndInviteEnterpriseUserEndpoint

EnterpriseAdminProvisionAndInviteEnterpriseUserEndpoint: { emails: EnterpriseAdminProvisionAndInviteEnterpriseUserParamsEmails[]; enterprise: string; groups?: EnterpriseAdminProvisionAndInviteEnterpriseUserParamsGroups[]; name: EnterpriseAdminProvisionAndInviteEnterpriseUserParamsName; schemas: string[]; userName: string }

Type declaration

EnterpriseAdminProvisionAndInviteEnterpriseUserParamsEmails

EnterpriseAdminProvisionAndInviteEnterpriseUserParamsEmails: { primary: boolean; type: string; value: string }

Type declaration

  • primary: boolean
  • type: string
  • value: string

EnterpriseAdminProvisionAndInviteEnterpriseUserParamsGroups

EnterpriseAdminProvisionAndInviteEnterpriseUserParamsGroups: { value?: undefined | string }

Type declaration

  • Optional value?: undefined | string

EnterpriseAdminProvisionAndInviteEnterpriseUserParamsName

EnterpriseAdminProvisionAndInviteEnterpriseUserParamsName: { familyName: string; givenName: string }

Type declaration

  • familyName: string
  • givenName: string

EnterpriseAdminProvisionAndInviteEnterpriseUserRequestOptions

EnterpriseAdminProvisionAndInviteEnterpriseUserRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/scim/v2/enterprises/:enterprise/Users" }

Type declaration

EnterpriseAdminSetInformationForProvisionedEnterpriseGroupEndpoint

EnterpriseAdminSetInformationForProvisionedEnterpriseGroupEndpoint: { displayName: string; enterprise: string; members?: EnterpriseAdminSetInformationForProvisionedEnterpriseGroupParamsMembers[]; schemas: string[]; scim_group_id: string }

Type declaration

EnterpriseAdminSetInformationForProvisionedEnterpriseGroupParamsMembers

EnterpriseAdminSetInformationForProvisionedEnterpriseGroupParamsMembers: { value: string }

Type declaration

  • value: string

EnterpriseAdminSetInformationForProvisionedEnterpriseGroupRequestOptions

EnterpriseAdminSetInformationForProvisionedEnterpriseGroupRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/scim/v2/enterprises/:enterprise/Groups/:scim_group_id" }

Type declaration

EnterpriseAdminSetInformationForProvisionedEnterpriseUserEndpoint

EnterpriseAdminSetInformationForProvisionedEnterpriseUserEndpoint: { emails: EnterpriseAdminSetInformationForProvisionedEnterpriseUserParamsEmails[]; enterprise: string; groups?: EnterpriseAdminSetInformationForProvisionedEnterpriseUserParamsGroups[]; name: EnterpriseAdminSetInformationForProvisionedEnterpriseUserParamsName; schemas: string[]; scim_user_id: string; userName: string }

Type declaration

EnterpriseAdminSetInformationForProvisionedEnterpriseUserParamsEmails

EnterpriseAdminSetInformationForProvisionedEnterpriseUserParamsEmails: { primary: boolean; type: string; value: string }

Type declaration

  • primary: boolean
  • type: string
  • value: string

EnterpriseAdminSetInformationForProvisionedEnterpriseUserParamsGroups

EnterpriseAdminSetInformationForProvisionedEnterpriseUserParamsGroups: { value?: undefined | string }

Type declaration

  • Optional value?: undefined | string

EnterpriseAdminSetInformationForProvisionedEnterpriseUserParamsName

EnterpriseAdminSetInformationForProvisionedEnterpriseUserParamsName: { familyName: string; givenName: string }

Type declaration

  • familyName: string
  • givenName: string

EnterpriseAdminSetInformationForProvisionedEnterpriseUserRequestOptions

EnterpriseAdminSetInformationForProvisionedEnterpriseUserRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/scim/v2/enterprises/:enterprise/Users/:scim_user_id" }

Type declaration

EnterpriseAdminUpdateAttributeForEnterpriseGroupEndpoint

EnterpriseAdminUpdateAttributeForEnterpriseGroupEndpoint: { Operations: EnterpriseAdminUpdateAttributeForEnterpriseGroupParamsOperations[]; enterprise: string; schemas: string[]; scim_group_id: string }

Type declaration

EnterpriseAdminUpdateAttributeForEnterpriseGroupParamsOperations

EnterpriseAdminUpdateAttributeForEnterpriseGroupParamsOperations: {}

Type declaration

EnterpriseAdminUpdateAttributeForEnterpriseGroupRequestOptions

EnterpriseAdminUpdateAttributeForEnterpriseGroupRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/scim/v2/enterprises/:enterprise/Groups/:scim_group_id" }

Type declaration

EnterpriseAdminUpdateAttributeForEnterpriseUserEndpoint

EnterpriseAdminUpdateAttributeForEnterpriseUserEndpoint: { Operations: EnterpriseAdminUpdateAttributeForEnterpriseUserParamsOperations[]; enterprise: string; schemas: string[]; scim_user_id: string }

Type declaration

EnterpriseAdminUpdateAttributeForEnterpriseUserParamsOperations

EnterpriseAdminUpdateAttributeForEnterpriseUserParamsOperations: {}

Type declaration

EnterpriseAdminUpdateAttributeForEnterpriseUserRequestOptions

EnterpriseAdminUpdateAttributeForEnterpriseUserRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/scim/v2/enterprises/:enterprise/Users/:scim_user_id" }

Type declaration

GistsCheckIsStarredEndpoint

GistsCheckIsStarredEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

GistsCheckIsStarredRequestOptions

GistsCheckIsStarredRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id/star" }

Type declaration

GistsCreateCommentEndpoint

GistsCreateCommentEndpoint: { body: string; gist_id: string }

Type declaration

  • body: string

    The comment text.

  • gist_id: string

GistsCreateCommentRequestOptions

GistsCreateCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/gists/:gist_id/comments" }

Type declaration

GistsCreateEndpoint

GistsCreateEndpoint: { description?: undefined | string; files: GistsCreateParamsFiles; public?: undefined | false | true }

Type declaration

  • Optional description?: undefined | string

    A descriptive name for this gist.

  • files: GistsCreateParamsFiles

    The filenames and content of each file in the gist. The keys in the files object represent the filename and have the type string.

  • Optional public?: undefined | false | true

    When true, the gist will be public and available for anyone to see.

GistsCreateParamsFiles

GistsCreateParamsFiles: {}

Type declaration

GistsCreateParamsFilesKeyString

GistsCreateParamsFilesKeyString: { content: string }

Type declaration

  • content: string

GistsCreateRequestOptions

GistsCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/gists" }

Type declaration

GistsDeleteCommentEndpoint

GistsDeleteCommentEndpoint: { comment_id: number; gist_id: string }

Type declaration

  • comment_id: number
  • gist_id: string

GistsDeleteCommentRequestOptions

GistsDeleteCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/gists/:gist_id/comments/:comment_id" }

Type declaration

GistsDeleteEndpoint

GistsDeleteEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

GistsDeleteRequestOptions

GistsDeleteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/gists/:gist_id" }

Type declaration

GistsForkEndpoint

GistsForkEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

GistsForkRequestOptions

GistsForkRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/gists/:gist_id/forks" }

Type declaration

GistsGetCommentEndpoint

GistsGetCommentEndpoint: { comment_id: number; gist_id: string }

Type declaration

  • comment_id: number
  • gist_id: string

GistsGetCommentRequestOptions

GistsGetCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id/comments/:comment_id" }

Type declaration

GistsGetEndpoint

GistsGetEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

GistsGetRequestOptions

GistsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id" }

Type declaration

GistsGetRevisionEndpoint

GistsGetRevisionEndpoint: { gist_id: string; sha: string }

Type declaration

  • gist_id: string
  • sha: string

GistsGetRevisionRequestOptions

GistsGetRevisionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id/:sha" }

Type declaration

GistsListCommentsEndpoint

GistsListCommentsEndpoint: { gist_id: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • gist_id: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

GistsListCommentsRequestOptions

GistsListCommentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id/comments" }

Type declaration

GistsListCommentsResponseData

GistsListCommentsResponseData: { body: string; created_at: string; id: number; node_id: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

GistsListCommitsEndpoint

GistsListCommitsEndpoint: { gist_id: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • gist_id: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

GistsListCommitsRequestOptions

GistsListCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id/commits" }

Type declaration

GistsListCommitsResponseData

GistsListCommitsResponseData: { change_status: { additions: number; deletions: number; total: number }; committed_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; version: string }[]

GistsListEndpoint

GistsListEndpoint: { page?: undefined | number; per_page?: undefined | number; since?: undefined | string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

GistsListForUserEndpoint

GistsListForUserEndpoint: { page?: undefined | number; per_page?: undefined | number; since?: undefined | string; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

  • username: string

GistsListForUserRequestOptions

GistsListForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/gists" }

Type declaration

GistsListForUserResponseData

GistsListForUserResponseData: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: {}; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; public: boolean; truncated: boolean; updated_at: string; url: string; user: string }[]

GistsListForksEndpoint

GistsListForksEndpoint: { gist_id: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • gist_id: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

GistsListForksRequestOptions

GistsListForksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/:gist_id/forks" }

Type declaration

GistsListForksResponseData

GistsListForksResponseData: { created_at: string; id: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

GistsListPublicEndpoint

GistsListPublicEndpoint: { page?: undefined | number; per_page?: undefined | number; since?: undefined | string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

GistsListPublicRequestOptions

GistsListPublicRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/public" }

Type declaration

GistsListPublicResponseData

GistsListPublicResponseData: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: {}; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; public: boolean; truncated: boolean; updated_at: string; url: string; user: string }[]

GistsListRequestOptions

GistsListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists" }

Type declaration

GistsListResponseData

GistsListResponseData: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: {}; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; public: boolean; truncated: boolean; updated_at: string; url: string; user: string }[]

GistsListStarredEndpoint

GistsListStarredEndpoint: { page?: undefined | number; per_page?: undefined | number; since?: undefined | string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.

GistsListStarredRequestOptions

GistsListStarredRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gists/starred" }

Type declaration

GistsListStarredResponseData

GistsListStarredResponseData: { comments: number; comments_url: string; commits_url: string; created_at: string; description: string; files: {}; forks_url: string; git_pull_url: string; git_push_url: string; html_url: string; id: string; node_id: string; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; public: boolean; truncated: boolean; updated_at: string; url: string; user: string }[]

GistsStarEndpoint

GistsStarEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

GistsStarRequestOptions

GistsStarRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/gists/:gist_id/star" }

Type declaration

GistsUnstarEndpoint

GistsUnstarEndpoint: { gist_id: string }

Type declaration

  • gist_id: string

GistsUnstarRequestOptions

GistsUnstarRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/gists/:gist_id/star" }

Type declaration

GistsUpdateCommentEndpoint

GistsUpdateCommentEndpoint: { body: string; comment_id: number; gist_id: string }

Type declaration

  • body: string

    The comment text.

  • comment_id: number
  • gist_id: string

GistsUpdateCommentRequestOptions

GistsUpdateCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/gists/:gist_id/comments/:comment_id" }

Type declaration

GistsUpdateEndpoint

GistsUpdateEndpoint: { description?: undefined | string; files?: GistsUpdateParamsFiles; gist_id: string }

Type declaration

  • Optional description?: undefined | string

    A descriptive name for this gist.

  • Optional files?: GistsUpdateParamsFiles

    The filenames and content that make up this gist.

  • gist_id: string

GistsUpdateParamsFiles

GistsUpdateParamsFiles: {}

Type declaration

GistsUpdateParamsFilesKeyString

GistsUpdateParamsFilesKeyString: { content: string; filename: string }

Type declaration

  • content: string
  • filename: string

GistsUpdateRequestOptions

GistsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/gists/:gist_id" }

Type declaration

GitCreateBlobEndpoint

GitCreateBlobEndpoint: { content: string; encoding?: undefined | string; owner: string; repo: string }

Type declaration

  • content: string

    The new blob's content.

  • Optional encoding?: undefined | string

    The encoding used for content. Currently, "utf-8" and "base64" are supported.

  • owner: string
  • repo: string

GitCreateBlobRequestOptions

GitCreateBlobRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/blobs" }

Type declaration

GitCreateCommitEndpoint

GitCreateCommitEndpoint: { author?: GitCreateCommitParamsAuthor; committer?: GitCreateCommitParamsCommitter; message: string; owner: string; parents: string[]; repo: string; signature?: undefined | string; tree: string }

Type declaration

  • Optional author?: GitCreateCommitParamsAuthor

    Information about the author of the commit. By default, the author will be the authenticated user and the current date. See the author and committer object below for details.

  • Optional committer?: GitCreateCommitParamsCommitter

    Information about the person who is making the commit. By default, committer will use the information set in author. See the author and committer object below for details.

  • message: string

    The commit message

  • owner: string
  • parents: string[]

    The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.

  • repo: string
  • Optional signature?: undefined | string

    The PGP signature of the commit. GitHub adds the signature to the gpgsig header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a signature parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to use the command line to create signed commits.

  • tree: string

    The SHA of the tree object this commit points to

GitCreateCommitParamsAuthor

GitCreateCommitParamsAuthor: { date?: undefined | string; email?: undefined | string; name?: undefined | string }

Type declaration

  • Optional date?: undefined | string
  • Optional email?: undefined | string
  • Optional name?: undefined | string

GitCreateCommitParamsCommitter

GitCreateCommitParamsCommitter: { date?: undefined | string; email?: undefined | string; name?: undefined | string }

Type declaration

  • Optional date?: undefined | string
  • Optional email?: undefined | string
  • Optional name?: undefined | string

GitCreateCommitRequestOptions

GitCreateCommitRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/commits" }

Type declaration

GitCreateRefEndpoint

GitCreateRefEndpoint: { owner: string; ref: string; repo: string; sha: string }

Type declaration

  • owner: string
  • ref: string

    The name of the fully qualified reference (ie: refs/heads/master). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.

  • repo: string
  • sha: string

    The SHA1 value for this reference.

GitCreateRefRequestOptions

GitCreateRefRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/refs" }

Type declaration

GitCreateTagEndpoint

GitCreateTagEndpoint: { message: string; object: string; owner: string; repo: string; tag: string; tagger?: GitCreateTagParamsTagger; type: "commit" | "tree" | "blob" }

Type declaration

  • message: string

    The tag message.

  • object: string

    The SHA of the git object this is tagging.

  • owner: string
  • repo: string
  • tag: string

    The tag's name. This is typically a version (e.g., "v0.0.1").

  • Optional tagger?: GitCreateTagParamsTagger

    An object with information about the individual creating the tag.

  • type: "commit" | "tree" | "blob"

    The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.

GitCreateTagParamsTagger

GitCreateTagParamsTagger: { date?: undefined | string; email?: undefined | string; name?: undefined | string }

Type declaration

  • Optional date?: undefined | string
  • Optional email?: undefined | string
  • Optional name?: undefined | string

GitCreateTagRequestOptions

GitCreateTagRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/tags" }

Type declaration

GitCreateTreeEndpoint

GitCreateTreeEndpoint: { base_tree?: undefined | string; owner: string; repo: string; tree: GitCreateTreeParamsTree[] }

Type declaration

  • Optional base_tree?: undefined | string

    The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.

  • owner: string
  • repo: string
  • tree: GitCreateTreeParamsTree[]

    Objects (of path, mode, type, and sha) specifying a tree structure.

GitCreateTreeParamsTree

GitCreateTreeParamsTree: { content?: undefined | string; mode?: "100644" | "100755" | "040000" | "160000" | "120000"; path?: undefined | string; sha?: string | null; type?: "blob" | "tree" | "commit" }

Type declaration

  • Optional content?: undefined | string
  • Optional mode?: "100644" | "100755" | "040000" | "160000" | "120000"
  • Optional path?: undefined | string
  • Optional sha?: string | null
  • Optional type?: "blob" | "tree" | "commit"

GitCreateTreeRequestOptions

GitCreateTreeRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/trees" }

Type declaration

GitDeleteRefEndpoint

GitDeleteRefEndpoint: { owner: string; ref: string; repo: string }

Type declaration

  • owner: string
  • ref: string
  • repo: string

GitDeleteRefRequestOptions

GitDeleteRefRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/refs/:ref" }

Type declaration

GitGetBlobEndpoint

GitGetBlobEndpoint: { file_sha: string; owner: string; repo: string }

Type declaration

  • file_sha: string
  • owner: string
  • repo: string

GitGetBlobRequestOptions

GitGetBlobRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/blobs/:file_sha" }

Type declaration

GitGetCommitEndpoint

GitGetCommitEndpoint: { commit_sha: string; owner: string; repo: string }

Type declaration

  • commit_sha: string
  • owner: string
  • repo: string

GitGetCommitRequestOptions

GitGetCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/commits/:commit_sha" }

Type declaration

GitGetRefEndpoint

GitGetRefEndpoint: { owner: string; ref: string; repo: string }

Type declaration

  • owner: string
  • ref: string
  • repo: string

GitGetRefRequestOptions

GitGetRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/ref/:ref" }

Type declaration

GitGetTagEndpoint

GitGetTagEndpoint: { owner: string; repo: string; tag_sha: string }

Type declaration

  • owner: string
  • repo: string
  • tag_sha: string

GitGetTagRequestOptions

GitGetTagRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/tags/:tag_sha" }

Type declaration

GitGetTreeEndpoint

GitGetTreeEndpoint: { owner: string; recursive?: undefined | string; repo: string; tree_sha: string }

Type declaration

  • owner: string
  • Optional recursive?: undefined | string

    Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in :tree_sha. For example, setting recursive to any of the following will enable returning objects or subtrees: 0, 1, "true", and "false". Omit this parameter to prevent recursively returning objects or subtrees.

  • repo: string
  • tree_sha: string

GitGetTreeRequestOptions

GitGetTreeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/trees/:tree_sha" }

Type declaration

GitListMatchingRefsEndpoint

GitListMatchingRefsEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; ref: string; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • ref: string
  • repo: string

GitListMatchingRefsRequestOptions

GitListMatchingRefsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/matching-refs/:ref" }

Type declaration

GitListMatchingRefsResponseData

GitListMatchingRefsResponseData: { node_id: string; object: { sha: string; type: string; url: string }; ref: string; url: string }[]

GitUpdateRefEndpoint

GitUpdateRefEndpoint: { force?: undefined | false | true; owner: string; ref: string; repo: string; sha: string }

Type declaration

  • Optional force?: undefined | false | true

    Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to false will make sure you're not overwriting work.

  • owner: string
  • ref: string
  • repo: string
  • sha: string

    The SHA1 value to set this reference to

GitUpdateRefRequestOptions

GitUpdateRefRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/git/refs/:ref" }

Type declaration

GitignoreGetAllTemplatesEndpoint

GitignoreGetAllTemplatesEndpoint: {}

Type declaration

GitignoreGetAllTemplatesRequestOptions

GitignoreGetAllTemplatesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gitignore/templates" }

Type declaration

GitignoreGetAllTemplatesResponseData

GitignoreGetAllTemplatesResponseData: string[]

GitignoreGetTemplateEndpoint

GitignoreGetTemplateEndpoint: { name: string }

Type declaration

  • name: string

GitignoreGetTemplateRequestOptions

GitignoreGetTemplateRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/gitignore/templates/:name" }

Type declaration

InteractionsGetRestrictionsForOrgEndpoint

InteractionsGetRestrictionsForOrgEndpoint: { org: string } & RequiredPreview<"sombra">

InteractionsGetRestrictionsForOrgRequestOptions

InteractionsGetRestrictionsForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/interaction-limits" }

Type declaration

InteractionsGetRestrictionsForRepoEndpoint

InteractionsGetRestrictionsForRepoEndpoint: { owner: string; repo: string } & RequiredPreview<"sombra">

InteractionsGetRestrictionsForRepoRequestOptions

InteractionsGetRestrictionsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/interaction-limits" }

Type declaration

InteractionsRemoveRestrictionsForOrgEndpoint

InteractionsRemoveRestrictionsForOrgEndpoint: { org: string } & RequiredPreview<"sombra">

InteractionsRemoveRestrictionsForOrgRequestOptions

InteractionsRemoveRestrictionsForOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/interaction-limits" }

Type declaration

InteractionsRemoveRestrictionsForRepoEndpoint

InteractionsRemoveRestrictionsForRepoEndpoint: { owner: string; repo: string } & RequiredPreview<"sombra">

InteractionsRemoveRestrictionsForRepoRequestOptions

InteractionsRemoveRestrictionsForRepoRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/interaction-limits" }

Type declaration

InteractionsSetRestrictionsForOrgEndpoint

InteractionsSetRestrictionsForOrgEndpoint: { limit: "existing_users" | "contributors_only" | "collaborators_only"; org: string } & RequiredPreview<"sombra">

InteractionsSetRestrictionsForOrgRequestOptions

InteractionsSetRestrictionsForOrgRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/interaction-limits" }

Type declaration

InteractionsSetRestrictionsForRepoEndpoint

InteractionsSetRestrictionsForRepoEndpoint: { limit: "existing_users" | "contributors_only" | "collaborators_only"; owner: string; repo: string } & RequiredPreview<"sombra">

InteractionsSetRestrictionsForRepoRequestOptions

InteractionsSetRestrictionsForRepoRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/interaction-limits" }

Type declaration

IssuesAddAssigneesEndpoint

IssuesAddAssigneesEndpoint: { assignees?: string[]; issue_number: number; owner: string; repo: string }

Type declaration

  • Optional assignees?: string[]

    Usernames of people to assign this issue to. NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise.

  • issue_number: number
  • owner: string
  • repo: string

IssuesAddAssigneesRequestOptions

IssuesAddAssigneesRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/assignees" }

Type declaration

IssuesAddLabelsEndpoint

IssuesAddLabelsEndpoint: { issue_number: number; labels: string[]; owner: string; repo: string }

Type declaration

  • issue_number: number
  • labels: string[]

    The name of the label to add to the issue. Must contain at least one label. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

  • owner: string
  • repo: string

IssuesAddLabelsRequestOptions

IssuesAddLabelsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/labels" }

Type declaration

IssuesAddLabelsResponseData

IssuesAddLabelsResponseData: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]

IssuesCheckUserCanBeAssignedEndpoint

IssuesCheckUserCanBeAssignedEndpoint: { assignee: string; owner: string; repo: string }

Type declaration

  • assignee: string
  • owner: string
  • repo: string

IssuesCheckUserCanBeAssignedRequestOptions

IssuesCheckUserCanBeAssignedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/assignees/:assignee" }

Type declaration

IssuesCreateCommentEndpoint

IssuesCreateCommentEndpoint: { body: string; issue_number: number; owner: string; repo: string }

Type declaration

  • body: string

    The contents of the comment.

  • issue_number: number
  • owner: string
  • repo: string

IssuesCreateCommentRequestOptions

IssuesCreateCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/comments" }

Type declaration

IssuesCreateEndpoint

IssuesCreateEndpoint: { assignee?: undefined | string; assignees?: string[]; body?: undefined | string; labels?: string[]; milestone?: undefined | number; owner: string; repo: string; title: string }

Type declaration

  • Optional assignee?: undefined | string

    Login for the user that this issue should be assigned to. NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. This field is deprecated.

  • Optional assignees?: string[]

    Logins for Users to assign to this issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

  • Optional body?: undefined | string

    The contents of the issue.

  • Optional labels?: string[]

    Labels to associate with this issue. NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise.

  • Optional milestone?: undefined | number

    The number of the milestone to associate this issue with. NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise.

  • owner: string
  • repo: string
  • title: string

    The title of the issue.

IssuesCreateLabelEndpoint

IssuesCreateLabelEndpoint: { color: string; description?: undefined | string; name: string; owner: string; repo: string }

Type declaration

  • color: string

    The hexadecimal color code for the label, without the leading #.

  • Optional description?: undefined | string

    A short description of the label.

  • name: string

    The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see emoji-cheat-sheet.com.

  • owner: string
  • repo: string

IssuesCreateLabelRequestOptions

IssuesCreateLabelRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/labels" }

Type declaration

IssuesCreateMilestoneEndpoint

IssuesCreateMilestoneEndpoint: { description?: undefined | string; due_on?: undefined | string; owner: string; repo: string; state?: "open" | "closed"; title: string }

Type declaration

  • Optional description?: undefined | string

    A description of the milestone.

  • Optional due_on?: undefined | string

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • owner: string
  • repo: string
  • Optional state?: "open" | "closed"

    The state of the milestone. Either open or closed.

  • title: string

    The title of the milestone.

IssuesCreateMilestoneRequestOptions

IssuesCreateMilestoneRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/milestones" }

Type declaration

IssuesCreateRequestOptions

IssuesCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues" }

Type declaration

IssuesDeleteCommentEndpoint

IssuesDeleteCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number
  • owner: string
  • repo: string

IssuesDeleteCommentRequestOptions

IssuesDeleteCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments/:comment_id" }

Type declaration

IssuesDeleteLabelEndpoint

IssuesDeleteLabelEndpoint: { name: string; owner: string; repo: string }

Type declaration

  • name: string
  • owner: string
  • repo: string

IssuesDeleteLabelRequestOptions

IssuesDeleteLabelRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/labels/:name" }

Type declaration

IssuesDeleteMilestoneEndpoint

IssuesDeleteMilestoneEndpoint: { milestone_number: number; owner: string; repo: string }

Type declaration

  • milestone_number: number
  • owner: string
  • repo: string

IssuesDeleteMilestoneRequestOptions

IssuesDeleteMilestoneRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/milestones/:milestone_number" }

Type declaration

IssuesGetCommentEndpoint

IssuesGetCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number
  • owner: string
  • repo: string

IssuesGetCommentRequestOptions

IssuesGetCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments/:comment_id" }

Type declaration

IssuesGetEndpoint

IssuesGetEndpoint: { issue_number: number; owner: string; repo: string }

Type declaration

  • issue_number: number
  • owner: string
  • repo: string

IssuesGetEventEndpoint

IssuesGetEventEndpoint: { event_id: number; owner: string; repo: string }

Type declaration

  • event_id: number
  • owner: string
  • repo: string

IssuesGetEventRequestOptions

IssuesGetEventRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/events/:event_id" }

Type declaration

IssuesGetLabelEndpoint

IssuesGetLabelEndpoint: { name: string; owner: string; repo: string }

Type declaration

  • name: string
  • owner: string
  • repo: string

IssuesGetLabelRequestOptions

IssuesGetLabelRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/labels/:name" }

Type declaration

IssuesGetMilestoneEndpoint

IssuesGetMilestoneEndpoint: { milestone_number: number; owner: string; repo: string }

Type declaration

  • milestone_number: number
  • owner: string
  • repo: string

IssuesGetMilestoneRequestOptions

IssuesGetMilestoneRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/milestones/:milestone_number" }

Type declaration

IssuesGetRequestOptions

IssuesGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number" }

Type declaration

IssuesListAssigneesEndpoint

IssuesListAssigneesEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListAssigneesRequestOptions

IssuesListAssigneesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/assignees" }

Type declaration

IssuesListAssigneesResponseData

IssuesListAssigneesResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

IssuesListCommentsEndpoint

IssuesListCommentsEndpoint: { issue_number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; since?: undefined | string }

Type declaration

  • issue_number: number
  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional since?: undefined | string

    Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

IssuesListCommentsForRepoEndpoint

IssuesListCommentsForRepoEndpoint: { direction?: "asc" | "desc"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; since?: undefined | string; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    Either asc or desc. Ignored without the sort parameter.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional since?: undefined | string

    Only comments updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated"

    Either created or updated.

IssuesListCommentsForRepoRequestOptions

IssuesListCommentsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments" }

Type declaration

IssuesListCommentsForRepoResponseData

IssuesListCommentsForRepoResponseData: { body: string; created_at: string; html_url: string; id: number; node_id: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

IssuesListCommentsRequestOptions

IssuesListCommentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/comments" }

Type declaration

IssuesListCommentsResponseData

IssuesListCommentsResponseData: { body: string; created_at: string; html_url: string; id: number; node_id: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

IssuesListEndpoint

IssuesListEndpoint: { direction?: "asc" | "desc"; filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; labels?: undefined | string; page?: undefined | number; per_page?: undefined | number; since?: undefined | string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc.

  • Optional filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"

    Indicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you * created: Issues created by you * mentioned: Issues mentioning you * subscribed: Issues you're subscribed to updates for * all: All issues the authenticated user can see, regardless of participation or creation

  • Optional labels?: undefined | string

    A list of comma separated label names. Example: bug,ui,@high

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

    Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated" | "comments"

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListEventsEndpoint

IssuesListEventsEndpoint: { issue_number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • issue_number: number
  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListEventsForRepoEndpoint

IssuesListEventsForRepoEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListEventsForRepoRequestOptions

IssuesListEventsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/events" }

Type declaration

IssuesListEventsForRepoResponseData

IssuesListEventsForRepoResponseData: { actor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; commit_id: string; commit_url: string; created_at: string; event: string; id: number; issue: { active_lock_reason: string; assignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; assignees: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]; body: string; closed_at: string; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]; labels_url: string; locked: boolean; milestone: { closed_at: string; closed_issues: number; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }; node_id: string; number: number; pull_request: { diff_url: string; html_url: string; patch_url: string; url: string }; repository_url: string; state: string; title: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }; node_id: string; url: string }[]

IssuesListEventsForTimelineEndpoint

IssuesListEventsForTimelineEndpoint: { issue_number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string } & RequiredPreview<"mockingbird">

IssuesListEventsForTimelineRequestOptions

IssuesListEventsForTimelineRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/timeline" }

Type declaration

IssuesListEventsForTimelineResponseData

IssuesListEventsForTimelineResponseData: { actor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; commit_id: string; commit_url: string; created_at: string; event: string; id: number; node_id: string; url: string }[]

IssuesListEventsRequestOptions

IssuesListEventsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/events" }

Type declaration

IssuesListEventsResponseData

IssuesListEventsResponseData: { actor: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; commit_id: string; commit_url: string; created_at: string; event: string; id: number; node_id: string; url: string }[]

IssuesListForAuthenticatedUserEndpoint

IssuesListForAuthenticatedUserEndpoint: { direction?: "asc" | "desc"; filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; labels?: undefined | string; page?: undefined | number; per_page?: undefined | number; since?: undefined | string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc.

  • Optional filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"

    Indicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you * created: Issues created by you * mentioned: Issues mentioning you * subscribed: Issues you're subscribed to updates for * all: All issues the authenticated user can see, regardless of participation or creation

  • Optional labels?: undefined | string

    A list of comma separated label names. Example: bug,ui,@high

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

    Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated" | "comments"

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListForAuthenticatedUserRequestOptions

IssuesListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/issues" }

Type declaration

IssuesListForAuthenticatedUserResponseData

IssuesListForAuthenticatedUserResponseData: { active_lock_reason: string; assignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; assignees: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]; body: string; closed_at: string; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]; labels_url: string; locked: boolean; milestone: { closed_at: string; closed_issues: number; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }; node_id: string; number: number; pull_request: { diff_url: string; html_url: string; patch_url: string; url: string }; repository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }; repository_url: string; state: string; title: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

IssuesListForOrgEndpoint

IssuesListForOrgEndpoint: { direction?: "asc" | "desc"; filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"; labels?: undefined | string; org: string; page?: undefined | number; per_page?: undefined | number; since?: undefined | string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc.

  • Optional filter?: "assigned" | "created" | "mentioned" | "subscribed" | "all"

    Indicates which sorts of issues to return. Can be one of: * assigned: Issues assigned to you * created: Issues created by you * mentioned: Issues mentioning you * subscribed: Issues you're subscribed to updates for * all: All issues the authenticated user can see, regardless of participation or creation

  • Optional labels?: undefined | string

    A list of comma separated label names. Example: bug,ui,@high

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional since?: undefined | string

    Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated" | "comments"

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListForOrgRequestOptions

IssuesListForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/issues" }

Type declaration

IssuesListForOrgResponseData

IssuesListForOrgResponseData: { active_lock_reason: string; assignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; assignees: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]; body: string; closed_at: string; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]; labels_url: string; locked: boolean; milestone: { closed_at: string; closed_issues: number; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }; node_id: string; number: number; pull_request: { diff_url: string; html_url: string; patch_url: string; url: string }; repository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }; repository_url: string; state: string; title: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

IssuesListForRepoEndpoint

IssuesListForRepoEndpoint: { assignee?: undefined | string; creator?: undefined | string; direction?: "asc" | "desc"; labels?: undefined | string; mentioned?: undefined | string; milestone?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; since?: undefined | string; sort?: "created" | "updated" | "comments"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional assignee?: undefined | string

    Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.

  • Optional creator?: undefined | string

    The user that created the issue.

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc.

  • Optional labels?: undefined | string

    A list of comma separated label names. Example: bug,ui,@high

  • Optional mentioned?: undefined | string

    A user that's mentioned in the issue.

  • Optional milestone?: undefined | string

    If an integer is passed, it should refer to a milestone by its number field. If the string * is passed, issues with any milestone are accepted. If the string none is passed, issues without milestones are returned.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional since?: undefined | string

    Only issues updated at or after this time are returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional sort?: "created" | "updated" | "comments"

    What to sort results by. Can be either created, updated, comments.

  • Optional state?: "open" | "closed" | "all"

    Indicates the state of the issues to return. Can be either open, closed, or all.

IssuesListForRepoRequestOptions

IssuesListForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues" }

Type declaration

IssuesListForRepoResponseData

IssuesListForRepoResponseData: { active_lock_reason: string; assignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; assignees: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]; body: string; closed_at: string; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]; labels_url: string; locked: boolean; milestone: { closed_at: string; closed_issues: number; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }; node_id: string; number: number; pull_request: { diff_url: string; html_url: string; patch_url: string; url: string }; repository_url: string; state: string; title: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

IssuesListLabelsForMilestoneEndpoint

IssuesListLabelsForMilestoneEndpoint: { milestone_number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • milestone_number: number
  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListLabelsForMilestoneRequestOptions

IssuesListLabelsForMilestoneRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/milestones/:milestone_number/labels" }

Type declaration

IssuesListLabelsForMilestoneResponseData

IssuesListLabelsForMilestoneResponseData: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]

IssuesListLabelsForRepoEndpoint

IssuesListLabelsForRepoEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListLabelsForRepoRequestOptions

IssuesListLabelsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/labels" }

Type declaration

IssuesListLabelsForRepoResponseData

IssuesListLabelsForRepoResponseData: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]

IssuesListLabelsOnIssueEndpoint

IssuesListLabelsOnIssueEndpoint: { issue_number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • issue_number: number
  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

IssuesListLabelsOnIssueRequestOptions

IssuesListLabelsOnIssueRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/labels" }

Type declaration

IssuesListLabelsOnIssueResponseData

IssuesListLabelsOnIssueResponseData: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]

IssuesListMilestonesEndpoint

IssuesListMilestonesEndpoint: { direction?: "asc" | "desc"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; sort?: "due_on" | "completeness"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Either asc or desc.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional sort?: "due_on" | "completeness"

    What to sort results by. Either due_on or completeness.

  • Optional state?: "open" | "closed" | "all"

    The state of the milestone. Either open, closed, or all.

IssuesListMilestonesRequestOptions

IssuesListMilestonesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/milestones" }

Type declaration

IssuesListMilestonesResponseData

IssuesListMilestonesResponseData: { closed_at: string; closed_issues: number; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }[]

IssuesListRequestOptions

IssuesListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/issues" }

Type declaration

IssuesListResponseData

IssuesListResponseData: { active_lock_reason: string; assignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; assignees: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]; body: string; closed_at: string; comments: number; comments_url: string; created_at: string; events_url: string; html_url: string; id: number; labels: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]; labels_url: string; locked: boolean; milestone: { closed_at: string; closed_issues: number; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }; node_id: string; number: number; pull_request: { diff_url: string; html_url: string; patch_url: string; url: string }; repository: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }; repository_url: string; state: string; title: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

IssuesLockEndpoint

IssuesLockEndpoint: { issue_number: number; lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; owner: string; repo: string }

Type declaration

  • issue_number: number
  • Optional lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"

    The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: * off-topic * too heated * resolved * spam

  • owner: string
  • repo: string

IssuesLockRequestOptions

IssuesLockRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/lock" }

Type declaration

IssuesRemoveAllLabelsEndpoint

IssuesRemoveAllLabelsEndpoint: { issue_number: number; owner: string; repo: string }

Type declaration

  • issue_number: number
  • owner: string
  • repo: string

IssuesRemoveAllLabelsRequestOptions

IssuesRemoveAllLabelsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/labels" }

Type declaration

IssuesRemoveAssigneesEndpoint

IssuesRemoveAssigneesEndpoint: { assignees?: string[]; issue_number: number; owner: string; repo: string }

Type declaration

  • Optional assignees?: string[]

    Usernames of assignees to remove from an issue. NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise.

  • issue_number: number
  • owner: string
  • repo: string

IssuesRemoveAssigneesRequestOptions

IssuesRemoveAssigneesRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/assignees" }

Type declaration

IssuesRemoveLabelEndpoint

IssuesRemoveLabelEndpoint: { issue_number: number; name: string; owner: string; repo: string }

Type declaration

  • issue_number: number
  • name: string
  • owner: string
  • repo: string

IssuesRemoveLabelRequestOptions

IssuesRemoveLabelRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/labels/:name" }

Type declaration

IssuesRemoveLabelResponseData

IssuesRemoveLabelResponseData: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]

IssuesSetLabelsEndpoint

IssuesSetLabelsEndpoint: { issue_number: number; labels?: string[]; owner: string; repo: string }

Type declaration

  • issue_number: number
  • Optional labels?: string[]

    The names of the labels to add to the issue. You can pass an empty array to remove all labels. Note: Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key.

  • owner: string
  • repo: string

IssuesSetLabelsRequestOptions

IssuesSetLabelsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/labels" }

Type declaration

IssuesSetLabelsResponseData

IssuesSetLabelsResponseData: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]

IssuesUnlockEndpoint

IssuesUnlockEndpoint: { issue_number: number; owner: string; repo: string }

Type declaration

  • issue_number: number
  • owner: string
  • repo: string

IssuesUnlockRequestOptions

IssuesUnlockRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/lock" }

Type declaration

IssuesUpdateCommentEndpoint

IssuesUpdateCommentEndpoint: { body: string; comment_id: number; owner: string; repo: string }

Type declaration

  • body: string

    The contents of the comment.

  • comment_id: number
  • owner: string
  • repo: string

IssuesUpdateCommentRequestOptions

IssuesUpdateCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments/:comment_id" }

Type declaration

IssuesUpdateEndpoint

IssuesUpdateEndpoint: { assignee?: undefined | string; assignees?: string[]; body?: undefined | string; issue_number: number; labels?: string[]; milestone?: number | null; owner: string; repo: string; state?: "open" | "closed"; title?: undefined | string }

Type declaration

  • Optional assignee?: undefined | string

    Login for the user that this issue should be assigned to. This field is deprecated.

  • Optional assignees?: string[]

    Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise.

  • Optional body?: undefined | string

    The contents of the issue.

  • issue_number: number
  • Optional labels?: string[]

    Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise.

  • Optional milestone?: number | null

    The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise.

  • owner: string
  • repo: string
  • Optional state?: "open" | "closed"

    State of the issue. Either open or closed.

  • Optional title?: undefined | string

    The title of the issue.

IssuesUpdateLabelEndpoint

IssuesUpdateLabelEndpoint: { color?: undefined | string; description?: undefined | string; name: string; new_name?: undefined | string; owner: string; repo: string }

Type declaration

  • Optional color?: undefined | string

    The hexadecimal color code for the label, without the leading #.

  • Optional description?: undefined | string

    A short description of the label.

  • name: string
  • Optional new_name?: undefined | string

    The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see emoji-cheat-sheet.com.

  • owner: string
  • repo: string

IssuesUpdateLabelRequestOptions

IssuesUpdateLabelRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/labels/:name" }

Type declaration

IssuesUpdateMilestoneEndpoint

IssuesUpdateMilestoneEndpoint: { description?: undefined | string; due_on?: undefined | string; milestone_number: number; owner: string; repo: string; state?: "open" | "closed"; title?: undefined | string }

Type declaration

  • Optional description?: undefined | string

    A description of the milestone.

  • Optional due_on?: undefined | string

    The milestone due date. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • milestone_number: number
  • owner: string
  • repo: string
  • Optional state?: "open" | "closed"

    The state of the milestone. Either open or closed.

  • Optional title?: undefined | string

    The title of the milestone.

IssuesUpdateMilestoneRequestOptions

IssuesUpdateMilestoneRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/milestones/:milestone_number" }

Type declaration

IssuesUpdateRequestOptions

IssuesUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number" }

Type declaration

LicensesGetAllCommonlyUsedEndpoint

LicensesGetAllCommonlyUsedEndpoint: {}

Type declaration

LicensesGetAllCommonlyUsedRequestOptions

LicensesGetAllCommonlyUsedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/licenses" }

Type declaration

LicensesGetAllCommonlyUsedResponseData

LicensesGetAllCommonlyUsedResponseData: { key: string; name: string; node_id: string; spdx_id: string; url: string }[]

LicensesGetEndpoint

LicensesGetEndpoint: { license: string }

Type declaration

  • license: string

LicensesGetForRepoEndpoint

LicensesGetForRepoEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

LicensesGetForRepoRequestOptions

LicensesGetForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/license" }

Type declaration

LicensesGetRequestOptions

LicensesGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/licenses/:license" }

Type declaration

MarkdownRenderEndpoint

MarkdownRenderEndpoint: { context?: undefined | string; mode?: "markdown" | "gfm"; text: string }

Type declaration

  • Optional context?: undefined | string

    The repository context to use when creating references in gfm mode. Omit this parameter when using markdown mode.

  • Optional mode?: "markdown" | "gfm"

    The rendering mode. Can be either: * markdown to render a document in plain Markdown, just like README.md files are rendered. * gfm to render a document in GitHub Flavored Markdown, which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.

  • text: string

    The Markdown text to render in HTML. Markdown content must be 400 KB or less.

MarkdownRenderRawEndpoint

MarkdownRenderRawEndpoint: { data: string } & { headers: { content-type: "text/plain; charset=utf-8" } }

MarkdownRenderRawRequestOptions

MarkdownRenderRawRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/markdown/raw" }

Type declaration

MarkdownRenderRequestOptions

MarkdownRenderRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/markdown" }

Type declaration

MetaGetEndpoint

MetaGetEndpoint: {}

Type declaration

MetaGetRequestOptions

MetaGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/meta" }

Type declaration

MigrationsCancelImportEndpoint

MigrationsCancelImportEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

MigrationsCancelImportRequestOptions

MigrationsCancelImportRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import" }

Type declaration

MigrationsDeleteArchiveForAuthenticatedUserEndpoint

MigrationsDeleteArchiveForAuthenticatedUserEndpoint: { migration_id: number } & RequiredPreview<"wyandotte">

MigrationsDeleteArchiveForAuthenticatedUserRequestOptions

MigrationsDeleteArchiveForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/migrations/:migration_id/archive" }

Type declaration

MigrationsDeleteArchiveForOrgEndpoint

MigrationsDeleteArchiveForOrgEndpoint: { migration_id: number; org: string } & RequiredPreview<"wyandotte">

MigrationsDeleteArchiveForOrgRequestOptions

MigrationsDeleteArchiveForOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/migrations/:migration_id/archive" }

Type declaration

MigrationsDownloadArchiveForOrgEndpoint

MigrationsDownloadArchiveForOrgEndpoint: { migration_id: number; org: string } & RequiredPreview<"wyandotte">

MigrationsDownloadArchiveForOrgRequestOptions

MigrationsDownloadArchiveForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/migrations/:migration_id/archive" }

Type declaration

MigrationsGetArchiveForAuthenticatedUserEndpoint

MigrationsGetArchiveForAuthenticatedUserEndpoint: { migration_id: number } & RequiredPreview<"wyandotte">

MigrationsGetArchiveForAuthenticatedUserRequestOptions

MigrationsGetArchiveForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/migrations/:migration_id/archive" }

Type declaration

MigrationsGetCommitAuthorsEndpoint

MigrationsGetCommitAuthorsEndpoint: { owner: string; repo: string; since?: undefined | string }

Type declaration

  • owner: string
  • repo: string
  • Optional since?: undefined | string

    Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the raw step.

MigrationsGetCommitAuthorsRequestOptions

MigrationsGetCommitAuthorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import/authors" }

Type declaration

MigrationsGetCommitAuthorsResponseData

MigrationsGetCommitAuthorsResponseData: { email: string; id: number; import_url: string; name: string; remote_id: string; remote_name: string; url: string }[]

MigrationsGetImportStatusEndpoint

MigrationsGetImportStatusEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

MigrationsGetImportStatusRequestOptions

MigrationsGetImportStatusRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import" }

Type declaration

MigrationsGetLargeFilesEndpoint

MigrationsGetLargeFilesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

MigrationsGetLargeFilesRequestOptions

MigrationsGetLargeFilesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import/large_files" }

Type declaration

MigrationsGetLargeFilesResponseData

MigrationsGetLargeFilesResponseData: { oid: string; path: string; ref_name: string; size: number }[]

MigrationsGetStatusForAuthenticatedUserEndpoint

MigrationsGetStatusForAuthenticatedUserEndpoint: { migration_id: number } & RequiredPreview<"wyandotte">

MigrationsGetStatusForAuthenticatedUserRequestOptions

MigrationsGetStatusForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/migrations/:migration_id" }

Type declaration

MigrationsGetStatusForOrgEndpoint

MigrationsGetStatusForOrgEndpoint: { migration_id: number; org: string } & RequiredPreview<"wyandotte">

MigrationsGetStatusForOrgRequestOptions

MigrationsGetStatusForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/migrations/:migration_id" }

Type declaration

MigrationsListForAuthenticatedUserEndpoint

MigrationsListForAuthenticatedUserEndpoint: { page?: undefined | number; per_page?: undefined | number } & RequiredPreview<"wyandotte">

MigrationsListForAuthenticatedUserRequestOptions

MigrationsListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/migrations" }

Type declaration

MigrationsListForAuthenticatedUserResponseData

MigrationsListForAuthenticatedUserResponseData: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; repositories: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }[]; state: string; updated_at: string; url: string }[]

MigrationsListForOrgEndpoint

MigrationsListForOrgEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number } & RequiredPreview<"wyandotte">

MigrationsListForOrgRequestOptions

MigrationsListForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/migrations" }

Type declaration

MigrationsListForOrgResponseData

MigrationsListForOrgResponseData: { created_at: string; exclude_attachments: boolean; guid: string; id: number; lock_repositories: boolean; owner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }; repositories: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }[]; state: string; updated_at: string; url: string }[]

MigrationsListReposForOrgEndpoint

MigrationsListReposForOrgEndpoint: { migration_id: number; org: string; page?: undefined | number; per_page?: undefined | number } & RequiredPreview<"wyandotte">

MigrationsListReposForOrgRequestOptions

MigrationsListReposForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/migrations/:migration_id/repositories" }

Type declaration

MigrationsListReposForOrgResponseData

MigrationsListReposForOrgResponseData: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; license: { key: string; name: string; node_id: string; spdx_id: string; url: string }; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }[]

MigrationsListReposForUserEndpoint

MigrationsListReposForUserEndpoint: { migration_id: number; page?: undefined | number; per_page?: undefined | number } & RequiredPreview<"wyandotte">

MigrationsListReposForUserRequestOptions

MigrationsListReposForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/migrations/:migration_id/repositories" }

Type declaration

MigrationsListReposForUserResponseData

MigrationsListReposForUserResponseData: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; license: { key: string; name: string; node_id: string; spdx_id: string; url: string }; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }[]

MigrationsMapCommitAuthorEndpoint

MigrationsMapCommitAuthorEndpoint: { author_id: number; email?: undefined | string; name?: undefined | string; owner: string; repo: string }

Type declaration

  • author_id: number
  • Optional email?: undefined | string

    The new Git author email.

  • Optional name?: undefined | string

    The new Git author name.

  • owner: string
  • repo: string

MigrationsMapCommitAuthorRequestOptions

MigrationsMapCommitAuthorRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import/authors/:author_id" }

Type declaration

MigrationsSetLfsPreferenceEndpoint

MigrationsSetLfsPreferenceEndpoint: { owner: string; repo: string; use_lfs: "opt_in" | "opt_out" }

Type declaration

  • owner: string
  • repo: string
  • use_lfs: "opt_in" | "opt_out"

    Can be one of opt_in (large files will be stored using Git LFS) or opt_out (large files will be removed during the import).

MigrationsSetLfsPreferenceRequestOptions

MigrationsSetLfsPreferenceRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import/lfs" }

Type declaration

MigrationsStartForAuthenticatedUserEndpoint

MigrationsStartForAuthenticatedUserEndpoint: { exclude_attachments?: undefined | false | true; lock_repositories?: undefined | false | true; repositories: string[] }

Type declaration

  • Optional exclude_attachments?: undefined | false | true

    Does not include attachments uploaded to GitHub.com in the migration data when set to true. Excluding attachments will reduce the migration archive file size.

  • Optional lock_repositories?: undefined | false | true

    Locks the repositories to prevent changes during the migration when set to true.

  • repositories: string[]

    An array of repositories to include in the migration.

MigrationsStartForAuthenticatedUserRequestOptions

MigrationsStartForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/user/migrations" }

Type declaration

MigrationsStartForOrgEndpoint

MigrationsStartForOrgEndpoint: { exclude_attachments?: undefined | false | true; lock_repositories?: undefined | false | true; org: string; repositories: string[] }

Type declaration

  • Optional exclude_attachments?: undefined | false | true

    Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).

  • Optional lock_repositories?: undefined | false | true

    Indicates whether repositories should be locked (to prevent manipulation) while migrating data.

  • org: string
  • repositories: string[]

    A list of arrays indicating which repositories should be migrated.

MigrationsStartForOrgRequestOptions

MigrationsStartForOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/migrations" }

Type declaration

MigrationsStartImportEndpoint

MigrationsStartImportEndpoint: { owner: string; repo: string; tfvc_project?: undefined | string; vcs?: "subversion" | "git" | "mercurial" | "tfvc"; vcs_password?: undefined | string; vcs_url: string; vcs_username?: undefined | string }

Type declaration

  • owner: string
  • repo: string
  • Optional tfvc_project?: undefined | string

    For a tfvc import, the name of the project that is being imported.

  • Optional vcs?: "subversion" | "git" | "mercurial" | "tfvc"

    The originating VCS type. Can be one of subversion, git, mercurial, or tfvc. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.

  • Optional vcs_password?: undefined | string

    If authentication is required, the password to provide to vcs_url.

  • vcs_url: string

    The URL of the originating repository.

  • Optional vcs_username?: undefined | string

    If authentication is required, the username to provide to vcs_url.

MigrationsStartImportRequestOptions

MigrationsStartImportRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import" }

Type declaration

MigrationsUnlockRepoForAuthenticatedUserEndpoint

MigrationsUnlockRepoForAuthenticatedUserEndpoint: { migration_id: number; repo_name: string } & RequiredPreview<"wyandotte">

MigrationsUnlockRepoForAuthenticatedUserRequestOptions

MigrationsUnlockRepoForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/migrations/:migration_id/repos/:repo_name/lock" }

Type declaration

MigrationsUnlockRepoForOrgEndpoint

MigrationsUnlockRepoForOrgEndpoint: { migration_id: number; org: string; repo_name: string } & RequiredPreview<"wyandotte">

MigrationsUnlockRepoForOrgRequestOptions

MigrationsUnlockRepoForOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/migrations/:migration_id/repos/:repo_name/lock" }

Type declaration

MigrationsUpdateImportEndpoint

MigrationsUpdateImportEndpoint: { owner: string; repo: string; vcs_password?: undefined | string; vcs_username?: undefined | string }

Type declaration

  • owner: string
  • repo: string
  • Optional vcs_password?: undefined | string

    The password to provide to the originating repository.

  • Optional vcs_username?: undefined | string

    The username to provide to the originating repository.

MigrationsUpdateImportRequestOptions

MigrationsUpdateImportRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/import" }

Type declaration

OauthAuthorizationsCreateAuthorizationEndpoint

OauthAuthorizationsCreateAuthorizationEndpoint: { client_id?: undefined | string; client_secret?: undefined | string; fingerprint?: undefined | string; note: string; note_url?: undefined | string; scopes?: string[] }

Type declaration

  • Optional client_id?: undefined | string

    The 20 character OAuth app client key for which to create the token.

  • Optional client_secret?: undefined | string

    The 40 character OAuth app client secret for which to create the token.

  • Optional fingerprint?: undefined | string

    A unique string to distinguish an authorization from others created for the same client ID and user.

  • note: string

    A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.

  • Optional note_url?: undefined | string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsCreateAuthorizationRequestOptions

OauthAuthorizationsCreateAuthorizationRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/authorizations" }

Type declaration

OauthAuthorizationsDeleteAuthorizationEndpoint

OauthAuthorizationsDeleteAuthorizationEndpoint: { authorization_id: number }

Type declaration

  • authorization_id: number

OauthAuthorizationsDeleteAuthorizationRequestOptions

OauthAuthorizationsDeleteAuthorizationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/authorizations/:authorization_id" }

Type declaration

OauthAuthorizationsDeleteGrantEndpoint

OauthAuthorizationsDeleteGrantEndpoint: { grant_id: number }

Type declaration

  • grant_id: number

OauthAuthorizationsDeleteGrantRequestOptions

OauthAuthorizationsDeleteGrantRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/applications/grants/:grant_id" }

Type declaration

OauthAuthorizationsGetAuthorizationEndpoint

OauthAuthorizationsGetAuthorizationEndpoint: { authorization_id: number }

Type declaration

  • authorization_id: number

OauthAuthorizationsGetAuthorizationRequestOptions

OauthAuthorizationsGetAuthorizationRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/authorizations/:authorization_id" }

Type declaration

OauthAuthorizationsGetGrantEndpoint

OauthAuthorizationsGetGrantEndpoint: { grant_id: number }

Type declaration

  • grant_id: number

OauthAuthorizationsGetGrantRequestOptions

OauthAuthorizationsGetGrantRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/applications/grants/:grant_id" }

Type declaration

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintEndpoint: { client_id: string; client_secret: string; fingerprint: string; note?: undefined | string; note_url?: undefined | string; scopes?: string[] }

Type declaration

  • client_id: string
  • client_secret: string

    The 40 character OAuth app client secret associated with the client ID specified in the URL.

  • fingerprint: string
  • Optional note?: undefined | string

    A note to remind you what the OAuth token is for.

  • Optional note_url?: undefined | string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions

OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/authorizations/clients/:client_id/:fingerprint" }

Type declaration

OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint

OauthAuthorizationsGetOrCreateAuthorizationForAppEndpoint: { client_id: string; client_secret: string; fingerprint?: undefined | string; note?: undefined | string; note_url?: undefined | string; scopes?: string[] }

Type declaration

  • client_id: string
  • client_secret: string

    The 40 character OAuth app client secret associated with the client ID specified in the URL.

  • Optional fingerprint?: undefined | string

    A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to Get-or-create an authorization for a specific app and fingerprint.

  • Optional note?: undefined | string

    A note to remind you what the OAuth token is for.

  • Optional note_url?: undefined | string

    A URL to remind you what app the OAuth token is for.

  • Optional scopes?: string[]

    A list of scopes that this authorization is in.

OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions

OauthAuthorizationsGetOrCreateAuthorizationForAppRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/authorizations/clients/:client_id" }

Type declaration

OauthAuthorizationsListAuthorizationsEndpoint

OauthAuthorizationsListAuthorizationsEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OauthAuthorizationsListAuthorizationsRequestOptions

OauthAuthorizationsListAuthorizationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/authorizations" }

Type declaration

OauthAuthorizationsListAuthorizationsResponseData

OauthAuthorizationsListAuthorizationsResponseData: { app: { client_id: string; name: string; url: string }; created_at: string; fingerprint: string; hashed_token: string; id: number; note: string; note_url: string; scopes: string[]; token: string; token_last_eight: string; updated_at: string; url: string }[]

OauthAuthorizationsListGrantsEndpoint

OauthAuthorizationsListGrantsEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OauthAuthorizationsListGrantsRequestOptions

OauthAuthorizationsListGrantsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/applications/grants" }

Type declaration

OauthAuthorizationsListGrantsResponseData

OauthAuthorizationsListGrantsResponseData: { app: { client_id: string; name: string; url: string }; created_at: string; id: number; scopes: string[]; updated_at: string; url: string }[]

OauthAuthorizationsUpdateAuthorizationEndpoint

OauthAuthorizationsUpdateAuthorizationEndpoint: { add_scopes?: string[]; authorization_id: number; fingerprint?: undefined | string; note?: undefined | string; note_url?: undefined | string; remove_scopes?: string[]; scopes?: string[] }

Type declaration

  • Optional add_scopes?: string[]

    A list of scopes to add to this authorization.

  • authorization_id: number
  • Optional fingerprint?: undefined | string

    A unique string to distinguish an authorization from others created for the same client ID and user.

  • Optional note?: undefined | string

    A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.

  • Optional note_url?: undefined | string

    A URL to remind you what app the OAuth token is for.

  • Optional remove_scopes?: string[]

    A list of scopes to remove from this authorization.

  • Optional scopes?: string[]

    Replaces the authorization scopes with these.

OauthAuthorizationsUpdateAuthorizationRequestOptions

OauthAuthorizationsUpdateAuthorizationRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/authorizations/:authorization_id" }

Type declaration

OrgsBlockUserEndpoint

OrgsBlockUserEndpoint: { org: string; username: string }

Type declaration

  • org: string
  • username: string

OrgsBlockUserRequestOptions

OrgsBlockUserRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/blocks/:username" }

Type declaration

OrgsCheckBlockedUserEndpoint

OrgsCheckBlockedUserEndpoint: { org: string; username: string }

Type declaration

  • org: string
  • username: string

OrgsCheckBlockedUserRequestOptions

OrgsCheckBlockedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/blocks/:username" }

Type declaration

OrgsCheckMembershipForUserEndpoint

OrgsCheckMembershipForUserEndpoint: { org: string; username: string }

Type declaration

  • org: string
  • username: string

OrgsCheckMembershipForUserRequestOptions

OrgsCheckMembershipForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/members/:username" }

Type declaration

OrgsCheckPublicMembershipForUserEndpoint

OrgsCheckPublicMembershipForUserEndpoint: { org: string; username: string }

Type declaration

  • org: string
  • username: string

OrgsCheckPublicMembershipForUserRequestOptions

OrgsCheckPublicMembershipForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/public_members/:username" }

Type declaration

OrgsConvertMemberToOutsideCollaboratorEndpoint

OrgsConvertMemberToOutsideCollaboratorEndpoint: { org: string; username: string }

Type declaration

  • org: string
  • username: string

OrgsConvertMemberToOutsideCollaboratorRequestOptions

OrgsConvertMemberToOutsideCollaboratorRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/outside_collaborators/:username" }

Type declaration

OrgsCreateInvitationEndpoint

OrgsCreateInvitationEndpoint: { email?: undefined | string; invitee_id?: undefined | number; org: string; role?: "admin" | "direct_member" | "billing_manager"; team_ids?: number[] }

Type declaration

  • Optional email?: undefined | string

    Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user.

  • Optional invitee_id?: undefined | number

    Required unless you provide email. GitHub user ID for the person you are inviting.

  • org: string
  • Optional role?: "admin" | "direct_member" | "billing_manager"

    Specify role for new member. Can be one of: * admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. * direct_member - Non-owner organization members with ability to see other members and join teams by invitation. * billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.

  • Optional team_ids?: number[]

    Specify IDs for the teams you want to invite new members to.

OrgsCreateInvitationRequestOptions

OrgsCreateInvitationRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/invitations" }

Type declaration

OrgsCreateWebhookEndpoint

OrgsCreateWebhookEndpoint: { active?: undefined | false | true; config: OrgsCreateWebhookParamsConfig; events?: string[]; name: string; org: string }

Type declaration

  • Optional active?: undefined | false | true

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • config: OrgsCreateWebhookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for.

  • name: string

    Must be passed as "web".

  • org: string

OrgsCreateWebhookParamsConfig

OrgsCreateWebhookParamsConfig: { content_type?: undefined | string; insecure_ssl?: undefined | string; secret?: undefined | string; url: string }

Type declaration

  • Optional content_type?: undefined | string
  • Optional insecure_ssl?: undefined | string
  • Optional secret?: undefined | string
  • url: string

OrgsCreateWebhookRequestOptions

OrgsCreateWebhookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/hooks" }

Type declaration

OrgsDeleteWebhookEndpoint

OrgsDeleteWebhookEndpoint: { hook_id: number; org: string }

Type declaration

  • hook_id: number
  • org: string

OrgsDeleteWebhookRequestOptions

OrgsDeleteWebhookRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/hooks/:hook_id" }

Type declaration

OrgsGetEndpoint

OrgsGetEndpoint: { org: string }

Type declaration

  • org: string

OrgsGetMembershipForAuthenticatedUserEndpoint

OrgsGetMembershipForAuthenticatedUserEndpoint: { org: string }

Type declaration

  • org: string

OrgsGetMembershipForAuthenticatedUserRequestOptions

OrgsGetMembershipForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/memberships/orgs/:org" }

Type declaration

OrgsGetMembershipForUserEndpoint

OrgsGetMembershipForUserEndpoint: { org: string; username: string }

Type declaration

  • org: string
  • username: string

OrgsGetMembershipForUserRequestOptions

OrgsGetMembershipForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/memberships/:username" }

Type declaration

OrgsGetRequestOptions

OrgsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org" }

Type declaration

OrgsGetWebhookEndpoint

OrgsGetWebhookEndpoint: { hook_id: number; org: string }

Type declaration

  • hook_id: number
  • org: string

OrgsGetWebhookRequestOptions

OrgsGetWebhookRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/hooks/:hook_id" }

Type declaration

OrgsListAppInstallationsEndpoint

OrgsListAppInstallationsEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number } & RequiredPreview<"machine-man">

OrgsListAppInstallationsRequestOptions

OrgsListAppInstallationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/installations" }

Type declaration

OrgsListBlockedUsersEndpoint

OrgsListBlockedUsersEndpoint: { org: string }

Type declaration

  • org: string

OrgsListBlockedUsersRequestOptions

OrgsListBlockedUsersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/blocks" }

Type declaration

OrgsListBlockedUsersResponseData

OrgsListBlockedUsersResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

OrgsListEndpoint

OrgsListEndpoint: { since?: undefined | number }

Type declaration

  • Optional since?: undefined | number

    The integer ID of the last organization that you've seen.

OrgsListForAuthenticatedUserEndpoint

OrgsListForAuthenticatedUserEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListForAuthenticatedUserRequestOptions

OrgsListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/orgs" }

Type declaration

OrgsListForAuthenticatedUserResponseData

OrgsListForAuthenticatedUserResponseData: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }[]

OrgsListForUserEndpoint

OrgsListForUserEndpoint: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

OrgsListForUserRequestOptions

OrgsListForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/orgs" }

Type declaration

OrgsListForUserResponseData

OrgsListForUserResponseData: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }[]

OrgsListInvitationTeamsEndpoint

OrgsListInvitationTeamsEndpoint: { invitation_id: number; org: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • invitation_id: number
  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListInvitationTeamsRequestOptions

OrgsListInvitationTeamsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/invitations/:invitation_id/teams" }

Type declaration

OrgsListInvitationTeamsResponseData

OrgsListInvitationTeamsResponseData: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: {}; permission: string; privacy: string; repositories_url: string; slug: string; url: string }[]

OrgsListMembersEndpoint

OrgsListMembersEndpoint: { filter?: "2fa_disabled" | "all"; org: string; page?: undefined | number; per_page?: undefined | number; role?: "all" | "admin" | "member" }

Type declaration

  • Optional filter?: "2fa_disabled" | "all"

    Filter members returned in the list. Can be one of: * 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners. * all - All members the authenticated user can see.

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional role?: "all" | "admin" | "member"

    Filter members returned by their role. Can be one of: * all - All members of the organization, regardless of role. * admin - Organization owners. * member - Non-owner organization members.

OrgsListMembersRequestOptions

OrgsListMembersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/members" }

Type declaration

OrgsListMembersResponseData

OrgsListMembersResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

OrgsListMembershipsForAuthenticatedUserEndpoint

OrgsListMembershipsForAuthenticatedUserEndpoint: { page?: undefined | number; per_page?: undefined | number; state?: "active" | "pending" }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional state?: "active" | "pending"

    Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships.

OrgsListMembershipsForAuthenticatedUserRequestOptions

OrgsListMembershipsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/memberships/orgs" }

Type declaration

OrgsListMembershipsForAuthenticatedUserResponseData

OrgsListMembershipsForAuthenticatedUserResponseData: { organization: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }; organization_url: string; role: string; state: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

OrgsListOutsideCollaboratorsEndpoint

OrgsListOutsideCollaboratorsEndpoint: { filter?: "2fa_disabled" | "all"; org: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional filter?: "2fa_disabled" | "all"

    Filter the list of outside collaborators. Can be one of: * 2fa_disabled: Outside collaborators without two-factor authentication enabled. * all: All outside collaborators.

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListOutsideCollaboratorsRequestOptions

OrgsListOutsideCollaboratorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/outside_collaborators" }

Type declaration

OrgsListOutsideCollaboratorsResponseData

OrgsListOutsideCollaboratorsResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

OrgsListPendingInvitationsEndpoint

OrgsListPendingInvitationsEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListPendingInvitationsRequestOptions

OrgsListPendingInvitationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/invitations" }

Type declaration

OrgsListPendingInvitationsResponseData

OrgsListPendingInvitationsResponseData: { created_at: string; email: string; id: number; invitation_team_url: string; inviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; login: string; role: string; team_count: number }[]

OrgsListPublicMembersEndpoint

OrgsListPublicMembersEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListPublicMembersRequestOptions

OrgsListPublicMembersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/public_members" }

Type declaration

OrgsListPublicMembersResponseData

OrgsListPublicMembersResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

OrgsListRequestOptions

OrgsListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/organizations" }

Type declaration

OrgsListResponseData

OrgsListResponseData: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }[]

OrgsListSamlSsoAuthorizationsEndpoint

OrgsListSamlSsoAuthorizationsEndpoint: { org: string }

Type declaration

  • org: string

OrgsListSamlSsoAuthorizationsRequestOptions

OrgsListSamlSsoAuthorizationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/credential-authorizations" }

Type declaration

OrgsListSamlSsoAuthorizationsResponseData

OrgsListSamlSsoAuthorizationsResponseData: { credential_authorized_at: string; credential_id: string; credential_type: string; login: string; scopes: string[]; token_last_eight: string }[]

OrgsListWebhooksEndpoint

OrgsListWebhooksEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

OrgsListWebhooksRequestOptions

OrgsListWebhooksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/hooks" }

Type declaration

OrgsListWebhooksResponseData

OrgsListWebhooksResponseData: { active: boolean; config: { content_type: string; url: string }; created_at: string; events: string[]; id: number; name: string; ping_url: string; updated_at: string; url: string }[]

OrgsPingWebhookEndpoint

OrgsPingWebhookEndpoint: { hook_id: number; org: string }

Type declaration

  • hook_id: number
  • org: string

OrgsPingWebhookRequestOptions

OrgsPingWebhookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/hooks/:hook_id/pings" }

Type declaration

OrgsRemoveMemberEndpoint

OrgsRemoveMemberEndpoint: { org: string; username: string }

Type declaration

  • org: string
  • username: string

OrgsRemoveMemberRequestOptions

OrgsRemoveMemberRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/members/:username" }

Type declaration

OrgsRemoveMembershipForUserEndpoint

OrgsRemoveMembershipForUserEndpoint: { org: string; username: string }

Type declaration

  • org: string
  • username: string

OrgsRemoveMembershipForUserRequestOptions

OrgsRemoveMembershipForUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/memberships/:username" }

Type declaration

OrgsRemoveOutsideCollaboratorEndpoint

OrgsRemoveOutsideCollaboratorEndpoint: { org: string; username: string }

Type declaration

  • org: string
  • username: string

OrgsRemoveOutsideCollaboratorRequestOptions

OrgsRemoveOutsideCollaboratorRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/outside_collaborators/:username" }

Type declaration

OrgsRemovePublicMembershipForAuthenticatedUserEndpoint

OrgsRemovePublicMembershipForAuthenticatedUserEndpoint: { org: string; username: string }

Type declaration

  • org: string
  • username: string

OrgsRemovePublicMembershipForAuthenticatedUserRequestOptions

OrgsRemovePublicMembershipForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/public_members/:username" }

Type declaration

OrgsRemoveSamlSsoAuthorizationEndpoint

OrgsRemoveSamlSsoAuthorizationEndpoint: { credential_id: number; org: string }

Type declaration

  • credential_id: number
  • org: string

OrgsRemoveSamlSsoAuthorizationRequestOptions

OrgsRemoveSamlSsoAuthorizationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/credential-authorizations/:credential_id" }

Type declaration

OrgsSetMembershipForUserEndpoint

OrgsSetMembershipForUserEndpoint: { org: string; role?: "admin" | "member"; username: string }

Type declaration

  • org: string
  • Optional role?: "admin" | "member"

    The role to give the user in the organization. Can be one of: * admin - The user will become an owner of the organization. * member - The user will become a non-owner member of the organization.

  • username: string

OrgsSetMembershipForUserRequestOptions

OrgsSetMembershipForUserRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/memberships/:username" }

Type declaration

OrgsSetPublicMembershipForAuthenticatedUserEndpoint

OrgsSetPublicMembershipForAuthenticatedUserEndpoint: { org: string; username: string }

Type declaration

  • org: string
  • username: string

OrgsSetPublicMembershipForAuthenticatedUserRequestOptions

OrgsSetPublicMembershipForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/public_members/:username" }

Type declaration

OrgsUnblockUserEndpoint

OrgsUnblockUserEndpoint: { org: string; username: string }

Type declaration

  • org: string
  • username: string

OrgsUnblockUserRequestOptions

OrgsUnblockUserRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/blocks/:username" }

Type declaration

OrgsUpdateEndpoint

OrgsUpdateEndpoint: { billing_email?: undefined | string; company?: undefined | string; default_repository_permission?: "read" | "write" | "admin" | "none"; description?: undefined | string; email?: undefined | string; has_organization_projects?: undefined | false | true; has_repository_projects?: undefined | false | true; location?: undefined | string; members_allowed_repository_creation_type?: "all" | "private" | "none"; members_can_create_internal_repositories?: undefined | false | true; members_can_create_private_repositories?: undefined | false | true; members_can_create_public_repositories?: undefined | false | true; members_can_create_repositories?: undefined | false | true; name?: undefined | string; org: string; twitter_username?: undefined | string }

Type declaration

  • Optional billing_email?: undefined | string

    Billing email address. This address is not publicized.

  • Optional company?: undefined | string

    The company name.

  • Optional default_repository_permission?: "read" | "write" | "admin" | "none"

    Default permission level members have for organization repositories: * read - can pull, but not push to or administer this repository. * write - can pull and push, but not administer this repository. * admin - can pull, push, and administer this repository. * none - no permissions granted by default.

  • Optional description?: undefined | string

    The description of the company.

  • Optional email?: undefined | string

    The publicly visible email address.

  • Optional has_organization_projects?: undefined | false | true

    Toggles whether an organization can use organization projects.

  • Optional has_repository_projects?: undefined | false | true

    Toggles whether repositories that belong to the organization can use repository projects.

  • Optional location?: undefined | string

    The location.

  • Optional members_allowed_repository_creation_type?: "all" | "private" | "none"

    Specifies which types of repositories non-admin organization members can create. Can be one of: * all - all organization members can create public and private repositories. * private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. * none - only admin members can create repositories. Note: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See this note for details.

  • Optional members_can_create_internal_repositories?: undefined | false | true

    Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: * true - all organization members can create internal repositories. * false - only organization owners can create internal repositories. Default: true. For more information, see "Restricting repository creation in your organization".

  • Optional members_can_create_private_repositories?: undefined | false | true

    Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: * true - all organization members can create private repositories. * false - only organization owners can create private repositories. Default: true. For more information, see "Restricting repository creation in your organization".

  • Optional members_can_create_public_repositories?: undefined | false | true

    Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: * true - all organization members can create public repositories. * false - only organization owners can create public repositories. Default: true. For more information, see "Restricting repository creation in your organization".

  • Optional members_can_create_repositories?: undefined | false | true

    Toggles the ability of non-admin organization members to create repositories. Can be one of: * true - all organization members can create repositories. * false - only organization owners can create repositories. Default: true Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

  • Optional name?: undefined | string

    The shorthand name of the company.

  • org: string
  • Optional twitter_username?: undefined | string

    The Twitter username of the company.

OrgsUpdateMembershipForAuthenticatedUserEndpoint

OrgsUpdateMembershipForAuthenticatedUserEndpoint: { org: string; state: "active" }

Type declaration

  • org: string
  • state: "active"

    The state that the membership should be in. Only "active" will be accepted.

OrgsUpdateMembershipForAuthenticatedUserRequestOptions

OrgsUpdateMembershipForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/user/memberships/orgs/:org" }

Type declaration

OrgsUpdateRequestOptions

OrgsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/orgs/:org" }

Type declaration

OrgsUpdateWebhookEndpoint

OrgsUpdateWebhookEndpoint: { active?: undefined | false | true; config?: OrgsUpdateWebhookParamsConfig; events?: string[]; hook_id: number; org: string }

Type declaration

  • Optional active?: undefined | false | true

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • Optional config?: OrgsUpdateWebhookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for.

  • hook_id: number
  • org: string

OrgsUpdateWebhookParamsConfig

OrgsUpdateWebhookParamsConfig: { content_type?: undefined | string; insecure_ssl?: undefined | string; secret?: undefined | string; url: string }

Type declaration

  • Optional content_type?: undefined | string
  • Optional insecure_ssl?: undefined | string
  • Optional secret?: undefined | string
  • url: string

OrgsUpdateWebhookRequestOptions

OrgsUpdateWebhookRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/orgs/:org/hooks/:hook_id" }

Type declaration

ProjectsAddCollaboratorEndpoint

ProjectsAddCollaboratorEndpoint: { permission?: "read" | "write" | "admin"; project_id: number; username: string } & RequiredPreview<"inertia">

ProjectsAddCollaboratorRequestOptions

ProjectsAddCollaboratorRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/projects/:project_id/collaborators/:username" }

Type declaration

ProjectsCreateCardEndpoint

ProjectsCreateCardEndpoint: { column_id: number; content_id?: undefined | number; content_type?: undefined | string; note?: undefined | string } & RequiredPreview<"inertia">

ProjectsCreateCardRequestOptions

ProjectsCreateCardRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/projects/columns/:column_id/cards" }

Type declaration

ProjectsCreateColumnEndpoint

ProjectsCreateColumnEndpoint: { name: string; project_id: number } & RequiredPreview<"inertia">

ProjectsCreateColumnRequestOptions

ProjectsCreateColumnRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/projects/:project_id/columns" }

Type declaration

ProjectsCreateForAuthenticatedUserEndpoint

ProjectsCreateForAuthenticatedUserEndpoint: { body?: undefined | string; name: string } & RequiredPreview<"inertia">

ProjectsCreateForAuthenticatedUserRequestOptions

ProjectsCreateForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/user/projects" }

Type declaration

ProjectsCreateForOrgEndpoint

ProjectsCreateForOrgEndpoint: { body?: undefined | string; name: string; org: string } & RequiredPreview<"inertia">

ProjectsCreateForOrgRequestOptions

ProjectsCreateForOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/projects" }

Type declaration

ProjectsCreateForRepoEndpoint

ProjectsCreateForRepoEndpoint: { body?: undefined | string; name: string; owner: string; repo: string } & RequiredPreview<"inertia">

ProjectsCreateForRepoRequestOptions

ProjectsCreateForRepoRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/projects" }

Type declaration

ProjectsDeleteCardEndpoint

ProjectsDeleteCardEndpoint: { card_id: number } & RequiredPreview<"inertia">

ProjectsDeleteCardRequestOptions

ProjectsDeleteCardRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/projects/columns/cards/:card_id" }

Type declaration

ProjectsDeleteColumnEndpoint

ProjectsDeleteColumnEndpoint: { column_id: number } & RequiredPreview<"inertia">

ProjectsDeleteColumnRequestOptions

ProjectsDeleteColumnRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/projects/columns/:column_id" }

Type declaration

ProjectsDeleteEndpoint

ProjectsDeleteEndpoint: { project_id: number } & RequiredPreview<"inertia">

ProjectsDeleteRequestOptions

ProjectsDeleteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/projects/:project_id" }

Type declaration

ProjectsGetCardEndpoint

ProjectsGetCardEndpoint: { card_id: number } & RequiredPreview<"inertia">

ProjectsGetCardRequestOptions

ProjectsGetCardRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/columns/cards/:card_id" }

Type declaration

ProjectsGetColumnEndpoint

ProjectsGetColumnEndpoint: { column_id: number } & RequiredPreview<"inertia">

ProjectsGetColumnRequestOptions

ProjectsGetColumnRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/columns/:column_id" }

Type declaration

ProjectsGetEndpoint

ProjectsGetEndpoint: { project_id: number } & RequiredPreview<"inertia">

ProjectsGetPermissionForUserEndpoint

ProjectsGetPermissionForUserEndpoint: { project_id: number; username: string } & RequiredPreview<"inertia">

ProjectsGetPermissionForUserRequestOptions

ProjectsGetPermissionForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/:project_id/collaborators/:username/permission" }

Type declaration

ProjectsGetRequestOptions

ProjectsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/:project_id" }

Type declaration

ProjectsListCardsEndpoint

ProjectsListCardsEndpoint: { archived_state?: "all" | "archived" | "not_archived"; column_id: number; page?: undefined | number; per_page?: undefined | number } & RequiredPreview<"inertia">

ProjectsListCardsRequestOptions

ProjectsListCardsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/columns/:column_id/cards" }

Type declaration

ProjectsListCardsResponseData

ProjectsListCardsResponseData: { archived: boolean; column_url: string; content_url: string; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; id: number; node_id: string; note: string; project_url: string; updated_at: string; url: string }[]

ProjectsListCollaboratorsEndpoint

ProjectsListCollaboratorsEndpoint: { affiliation?: "outside" | "direct" | "all"; page?: undefined | number; per_page?: undefined | number; project_id: number } & RequiredPreview<"inertia">

ProjectsListCollaboratorsRequestOptions

ProjectsListCollaboratorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/:project_id/collaborators" }

Type declaration

ProjectsListCollaboratorsResponseData

ProjectsListCollaboratorsResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

ProjectsListColumnsEndpoint

ProjectsListColumnsEndpoint: { page?: undefined | number; per_page?: undefined | number; project_id: number } & RequiredPreview<"inertia">

ProjectsListColumnsRequestOptions

ProjectsListColumnsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/projects/:project_id/columns" }

Type declaration

ProjectsListColumnsResponseData

ProjectsListColumnsResponseData: { cards_url: string; created_at: string; id: number; name: string; node_id: string; project_url: string; updated_at: string; url: string }[]

ProjectsListForOrgEndpoint

ProjectsListForOrgEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number; state?: "open" | "closed" | "all" } & RequiredPreview<"inertia">

ProjectsListForOrgRequestOptions

ProjectsListForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/projects" }

Type declaration

ProjectsListForOrgResponseData

ProjectsListForOrgResponseData: { body: string; columns_url: string; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }[]

ProjectsListForRepoEndpoint

ProjectsListForRepoEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; state?: "open" | "closed" | "all" } & RequiredPreview<"inertia">

ProjectsListForRepoRequestOptions

ProjectsListForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/projects" }

Type declaration

ProjectsListForRepoResponseData

ProjectsListForRepoResponseData: { body: string; columns_url: string; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }[]

ProjectsListForUserEndpoint

ProjectsListForUserEndpoint: { page?: undefined | number; per_page?: undefined | number; state?: "open" | "closed" | "all"; username: string } & RequiredPreview<"inertia">

ProjectsListForUserRequestOptions

ProjectsListForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/projects" }

Type declaration

ProjectsListForUserResponseData

ProjectsListForUserResponseData: { body: string; columns_url: string; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; html_url: string; id: number; name: string; node_id: string; number: number; owner_url: string; state: string; updated_at: string; url: string }[]

ProjectsMoveCardEndpoint

ProjectsMoveCardEndpoint: { card_id: number; column_id?: undefined | number; position: string } & RequiredPreview<"inertia">

ProjectsMoveCardRequestOptions

ProjectsMoveCardRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/projects/columns/cards/:card_id/moves" }

Type declaration

ProjectsMoveColumnEndpoint

ProjectsMoveColumnEndpoint: { column_id: number; position: string } & RequiredPreview<"inertia">

ProjectsMoveColumnRequestOptions

ProjectsMoveColumnRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/projects/columns/:column_id/moves" }

Type declaration

ProjectsRemoveCollaboratorEndpoint

ProjectsRemoveCollaboratorEndpoint: { project_id: number; username: string } & RequiredPreview<"inertia">

ProjectsRemoveCollaboratorRequestOptions

ProjectsRemoveCollaboratorRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/projects/:project_id/collaborators/:username" }

Type declaration

ProjectsUpdateCardEndpoint

ProjectsUpdateCardEndpoint: { archived?: undefined | false | true; card_id: number; note?: undefined | string } & RequiredPreview<"inertia">

ProjectsUpdateCardRequestOptions

ProjectsUpdateCardRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/projects/columns/cards/:card_id" }

Type declaration

ProjectsUpdateColumnEndpoint

ProjectsUpdateColumnEndpoint: { column_id: number; name: string } & RequiredPreview<"inertia">

ProjectsUpdateColumnRequestOptions

ProjectsUpdateColumnRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/projects/columns/:column_id" }

Type declaration

ProjectsUpdateEndpoint

ProjectsUpdateEndpoint: { body?: undefined | string; name?: undefined | string; organization_permission?: undefined | string; private?: undefined | false | true; project_id: number; state?: "open" | "closed" } & RequiredPreview<"inertia">

ProjectsUpdateRequestOptions

ProjectsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/projects/:project_id" }

Type declaration

PullsCheckIfMergedEndpoint

PullsCheckIfMergedEndpoint: { owner: string; pull_number: number; repo: string }

Type declaration

  • owner: string
  • pull_number: number
  • repo: string

PullsCheckIfMergedRequestOptions

PullsCheckIfMergedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/merge" }

Type declaration

PullsCreateEndpoint

PullsCreateEndpoint: { base: string; body?: undefined | string; draft?: undefined | false | true; head: string; maintainer_can_modify?: undefined | false | true; owner: string; repo: string; title: string }

Type declaration

  • base: string

    The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.

  • Optional body?: undefined | string

    The contents of the pull request.

  • Optional draft?: undefined | false | true

    Indicates whether the pull request is a draft. See "Draft Pull Requests" in the GitHub Help documentation to learn more.

  • head: string

    The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace head with a user like this: username:branch.

  • Optional maintainer_can_modify?: undefined | false | true

    Indicates whether maintainers can modify the pull request.

  • owner: string
  • repo: string
  • title: string

    The title of the new pull request.

PullsCreateReplyForReviewCommentEndpoint

PullsCreateReplyForReviewCommentEndpoint: { body: string; comment_id: number; owner: string; pull_number: number; repo: string }

Type declaration

  • body: string

    The text of the review comment.

  • comment_id: number
  • owner: string
  • pull_number: number
  • repo: string

PullsCreateReplyForReviewCommentRequestOptions

PullsCreateReplyForReviewCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies" }

Type declaration

PullsCreateRequestOptions

PullsCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls" }

Type declaration

PullsCreateReviewCommentEndpoint

PullsCreateReviewCommentEndpoint: { body: string; commit_id: string; line?: undefined | number; owner: string; path: string; position?: undefined | number; pull_number: number; repo: string; side?: "LEFT" | "RIGHT"; start_line?: undefined | number; start_side?: "LEFT" | "RIGHT" | "side" }

Type declaration

  • body: string

    The text of the review comment.

  • commit_id: string

    The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the position.

  • Optional line?: undefined | number

    Required with comfort-fade preview. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.

  • owner: string
  • path: string

    The relative path to the file that necessitates a comment.

  • Optional position?: undefined | number

    Required without comfort-fade preview. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.

  • pull_number: number
  • repo: string
  • Optional side?: "LEFT" | "RIGHT"

    Required with comfort-fade preview. In a split diff view, the side of the diff that the pull request's changes appear on. Can be LEFT or RIGHT. Use LEFT for deletions that appear in red. Use RIGHT for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "Diff view options".

  • Optional start_line?: undefined | number

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_line is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "Commenting on a pull request".

  • Optional start_side?: "LEFT" | "RIGHT" | "side"

    Required when using multi-line comments. To create multi-line comments, you must use the comfort-fade preview header. The start_side is the starting side of the diff that the comment applies to. Can be LEFT or RIGHT. To learn more about multi-line comments, see "Commenting on a pull request". See side in this table for additional context.

PullsCreateReviewCommentRequestOptions

PullsCreateReviewCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/comments" }

Type declaration

PullsCreateReviewEndpoint

PullsCreateReviewEndpoint: { body?: undefined | string; comments?: PullsCreateReviewParamsComments[]; commit_id?: undefined | string; event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; owner: string; pull_number: number; repo: string }

Type declaration

  • Optional body?: undefined | string

    Required when using REQUEST_CHANGES or COMMENT for the event parameter. The body text of the pull request review.

  • Optional comments?: PullsCreateReviewParamsComments[]

    Use the following table to specify the location, destination, and contents of the draft review comment.

  • Optional commit_id?: undefined | string

    The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the position. Defaults to the most recent commit in the pull request when you do not specify a value.

  • Optional event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. By leaving this blank, you set the review action state to PENDING, which means you will need to submit the pull request review when you are ready.

  • owner: string
  • pull_number: number
  • repo: string

PullsCreateReviewParamsComments

PullsCreateReviewParamsComments: { body: string; path: string; position: number }

Type declaration

  • body: string
  • path: string
  • position: number

PullsCreateReviewRequestOptions

PullsCreateReviewRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews" }

Type declaration

PullsDeletePendingReviewEndpoint

PullsDeletePendingReviewEndpoint: { owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • owner: string
  • pull_number: number
  • repo: string
  • review_id: number

PullsDeletePendingReviewRequestOptions

PullsDeletePendingReviewRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" }

Type declaration

PullsDeleteReviewCommentEndpoint

PullsDeleteReviewCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number
  • owner: string
  • repo: string

PullsDeleteReviewCommentRequestOptions

PullsDeleteReviewCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments/:comment_id" }

Type declaration

PullsDismissReviewEndpoint

PullsDismissReviewEndpoint: { message: string; owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • message: string

    The message for the pull request review dismissal

  • owner: string
  • pull_number: number
  • repo: string
  • review_id: number

PullsDismissReviewRequestOptions

PullsDismissReviewRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals" }

Type declaration

PullsGetEndpoint

PullsGetEndpoint: { owner: string; pull_number: number; repo: string }

Type declaration

  • owner: string
  • pull_number: number
  • repo: string

PullsGetRequestOptions

PullsGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number" }

Type declaration

PullsGetReviewCommentEndpoint

PullsGetReviewCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number
  • owner: string
  • repo: string

PullsGetReviewCommentRequestOptions

PullsGetReviewCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments/:comment_id" }

Type declaration

PullsGetReviewEndpoint

PullsGetReviewEndpoint: { owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • owner: string
  • pull_number: number
  • repo: string
  • review_id: number

PullsGetReviewRequestOptions

PullsGetReviewRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" }

Type declaration

PullsListCommentsForReviewEndpoint

PullsListCommentsForReviewEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; pull_number: number; repo: string; review_id: number }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • pull_number: number
  • repo: string
  • review_id: number

PullsListCommentsForReviewRequestOptions

PullsListCommentsForReviewRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments" }

Type declaration

PullsListCommentsForReviewResponseData

PullsListCommentsForReviewResponseData: { _links: { html: { href: string }; pull_request: { href: string }; self: { href: string } }; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; node_id: string; original_commit_id: string; original_position: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

PullsListCommitsEndpoint

PullsListCommitsEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; pull_number: number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • pull_number: number
  • repo: string

PullsListCommitsRequestOptions

PullsListCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/commits" }

Type declaration

PullsListCommitsResponseData

PullsListCommitsResponseData: { author: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; comments_url: string; commit: { author: { date: string; email: string; name: string }; comment_count: number; committer: { date: string; email: string; name: string }; message: string; tree: { sha: string; url: string }; url: string; verification: { payload: string; reason: string; signature: string; verified: boolean } }; committer: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; html_url: string; node_id: string; parents: { sha: string; url: string }[]; sha: string; url: string }[]

PullsListEndpoint

PullsListEndpoint: { base?: undefined | string; direction?: "asc" | "desc"; head?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; sort?: "created" | "updated" | "popularity" | "long-running"; state?: "open" | "closed" | "all" }

Type declaration

  • Optional base?: undefined | string

    Filter pulls by base branch name. Example: gh-pages.

  • Optional direction?: "asc" | "desc"

    The direction of the sort. Can be either asc or desc. Default: desc when sort is created or sort is not specified, otherwise asc.

  • Optional head?: undefined | string

    Filter pulls by head user or head organization and branch name in the format of user:ref-name or organization:ref-name. For example: github:new-script-format or octocat:test-branch.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional sort?: "created" | "updated" | "popularity" | "long-running"

    What to sort results by. Can be either created, updated, popularity (comment count) or long-running (age, filtering by pulls updated in the last month).

  • Optional state?: "open" | "closed" | "all"

    Either open, closed, or all to filter by state.

PullsListFilesEndpoint

PullsListFilesEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; pull_number: number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • pull_number: number
  • repo: string

PullsListFilesRequestOptions

PullsListFilesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/files" }

Type declaration

PullsListFilesResponseData

PullsListFilesResponseData: { additions: number; blob_url: string; changes: number; contents_url: string; deletions: number; filename: string; patch: string; raw_url: string; sha: string; status: string }[]

PullsListRequestOptions

PullsListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls" }

Type declaration

PullsListRequestedReviewersEndpoint

PullsListRequestedReviewersEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; pull_number: number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • pull_number: number
  • repo: string

PullsListRequestedReviewersRequestOptions

PullsListRequestedReviewersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" }

Type declaration

PullsListResponseData

PullsListResponseData: { _links: { comments: { href: string }; commits: { href: string }; html: { href: string }; issue: { href: string }; review_comment: { href: string }; review_comments: { href: string }; self: { href: string }; statuses: { href: string } }; active_lock_reason: string; assignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; assignees: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]; author_association: string; base: { label: string; ref: string; repo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }; sha: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }; body: string; closed_at: string; comments_url: string; commits_url: string; created_at: string; diff_url: string; draft: boolean; head: { label: string; ref: string; repo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }; sha: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }; html_url: string; id: number; issue_url: string; labels: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]; locked: boolean; merge_commit_sha: string; merged_at: string; milestone: { closed_at: string; closed_issues: number; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }; node_id: string; number: number; patch_url: string; requested_reviewers: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]; requested_teams: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: {}; permission: string; privacy: string; repositories_url: string; slug: string; url: string }[]; review_comment_url: string; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

PullsListReviewCommentsEndpoint

PullsListReviewCommentsEndpoint: { direction?: "asc" | "desc"; owner: string; page?: undefined | number; per_page?: undefined | number; pull_number: number; repo: string; since?: undefined | string; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be either asc or desc. Ignored without sort parameter.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • pull_number: number
  • repo: string
  • Optional since?: undefined | string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.

  • Optional sort?: "created" | "updated"

    Can be either created or updated comments.

PullsListReviewCommentsForRepoEndpoint

PullsListReviewCommentsForRepoEndpoint: { direction?: "asc" | "desc"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; since?: undefined | string; sort?: "created" | "updated" }

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be either asc or desc. Ignored without sort parameter.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional since?: undefined | string

    This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Only returns comments updated at or after this time.

  • Optional sort?: "created" | "updated"

    Can be either created or updated comments.

PullsListReviewCommentsForRepoRequestOptions

PullsListReviewCommentsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments" }

Type declaration

PullsListReviewCommentsForRepoResponseData

PullsListReviewCommentsForRepoResponseData: { _links: { html: { href: string }; pull_request: { href: string }; self: { href: string } }; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

PullsListReviewCommentsRequestOptions

PullsListReviewCommentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/comments" }

Type declaration

PullsListReviewCommentsResponseData

PullsListReviewCommentsResponseData: { _links: { html: { href: string }; pull_request: { href: string }; self: { href: string } }; author_association: string; body: string; commit_id: string; created_at: string; diff_hunk: string; html_url: string; id: number; in_reply_to_id: number; line: number; node_id: string; original_commit_id: string; original_line: number; original_position: number; original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; side: string; start_line: number; start_side: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

PullsListReviewsEndpoint

PullsListReviewsEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; pull_number: number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • pull_number: number
  • repo: string

PullsListReviewsRequestOptions

PullsListReviewsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews" }

Type declaration

PullsListReviewsResponseData

PullsListReviewsResponseData: { _links: { html: { href: string }; pull_request: { href: string } }; body: string; commit_id: string; html_url: string; id: number; node_id: string; pull_request_url: string; state: string; submitted_at: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

PullsMergeEndpoint

PullsMergeEndpoint: { commit_message?: undefined | string; commit_title?: undefined | string; merge_method?: "merge" | "squash" | "rebase"; owner: string; pull_number: number; repo: string; sha?: undefined | string }

Type declaration

  • Optional commit_message?: undefined | string

    Extra detail to append to automatic commit message.

  • Optional commit_title?: undefined | string

    Title for the automatic commit message.

  • Optional merge_method?: "merge" | "squash" | "rebase"

    Merge method to use. Possible values are merge, squash or rebase. Default is merge.

  • owner: string
  • pull_number: number
  • repo: string
  • Optional sha?: undefined | string

    SHA that pull request head must match to allow merge.

PullsMergeRequestOptions

PullsMergeRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/merge" }

Type declaration

PullsRemoveRequestedReviewersEndpoint

PullsRemoveRequestedReviewersEndpoint: { owner: string; pull_number: number; repo: string; reviewers?: string[]; team_reviewers?: string[] }

Type declaration

  • owner: string
  • pull_number: number
  • repo: string
  • Optional reviewers?: string[]

    An array of user logins that will be removed.

  • Optional team_reviewers?: string[]

    An array of team slugs that will be removed.

PullsRemoveRequestedReviewersRequestOptions

PullsRemoveRequestedReviewersRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" }

Type declaration

PullsRequestReviewersEndpoint

PullsRequestReviewersEndpoint: { owner: string; pull_number: number; repo: string; reviewers?: string[]; team_reviewers?: string[] }

Type declaration

  • owner: string
  • pull_number: number
  • repo: string
  • Optional reviewers?: string[]

    An array of user logins that will be requested.

  • Optional team_reviewers?: string[]

    An array of team slugs that will be requested.

PullsRequestReviewersRequestOptions

PullsRequestReviewersRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" }

Type declaration

PullsSubmitReviewEndpoint

PullsSubmitReviewEndpoint: { body?: undefined | string; event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • Optional body?: undefined | string

    The body text of the pull request review

  • event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"

    The review action you want to perform. The review actions include: APPROVE, REQUEST_CHANGES, or COMMENT. When you leave this blank, the API returns HTTP 422 (Unrecognizable entity) and sets the review action state to PENDING, which means you will need to re-submit the pull request review using a review action.

  • owner: string
  • pull_number: number
  • repo: string
  • review_id: number

PullsSubmitReviewRequestOptions

PullsSubmitReviewRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events" }

Type declaration

PullsUpdateBranchEndpoint

PullsUpdateBranchEndpoint: { expected_head_sha?: undefined | string; owner: string; pull_number: number; repo: string } & RequiredPreview<"lydian">

PullsUpdateBranchRequestOptions

PullsUpdateBranchRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/update-branch" }

Type declaration

PullsUpdateEndpoint

PullsUpdateEndpoint: { base?: undefined | string; body?: undefined | string; maintainer_can_modify?: undefined | false | true; owner: string; pull_number: number; repo: string; state?: "open" | "closed"; title?: undefined | string }

Type declaration

  • Optional base?: undefined | string

    The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.

  • Optional body?: undefined | string

    The contents of the pull request.

  • Optional maintainer_can_modify?: undefined | false | true

    Indicates whether maintainers can modify the pull request.

  • owner: string
  • pull_number: number
  • repo: string
  • Optional state?: "open" | "closed"

    State of this Pull Request. Either open or closed.

  • Optional title?: undefined | string

    The title of the pull request.

PullsUpdateRequestOptions

PullsUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number" }

Type declaration

PullsUpdateReviewCommentEndpoint

PullsUpdateReviewCommentEndpoint: { body: string; comment_id: number; owner: string; repo: string }

Type declaration

  • body: string

    The text of the reply to the review comment.

  • comment_id: number
  • owner: string
  • repo: string

PullsUpdateReviewCommentRequestOptions

PullsUpdateReviewCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments/:comment_id" }

Type declaration

PullsUpdateReviewEndpoint

PullsUpdateReviewEndpoint: { body: string; owner: string; pull_number: number; repo: string; review_id: number }

Type declaration

  • body: string

    The body text of the pull request review.

  • owner: string
  • pull_number: number
  • repo: string
  • review_id: number

PullsUpdateReviewRequestOptions

PullsUpdateReviewRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" }

Type declaration

RateLimitGetEndpoint

RateLimitGetEndpoint: {}

Type declaration

RateLimitGetRequestOptions

RateLimitGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/rate_limit" }

Type declaration

ReactionsCreateForCommitCommentEndpoint

ReactionsCreateForCommitCommentEndpoint: { comment_id: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; repo: string } & RequiredPreview<"squirrel-girl">

ReactionsCreateForCommitCommentRequestOptions

ReactionsCreateForCommitCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments/:comment_id/reactions" }

Type declaration

ReactionsCreateForIssueCommentEndpoint

ReactionsCreateForIssueCommentEndpoint: { comment_id: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; repo: string } & RequiredPreview<"squirrel-girl">

ReactionsCreateForIssueCommentRequestOptions

ReactionsCreateForIssueCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions" }

Type declaration

ReactionsCreateForIssueEndpoint

ReactionsCreateForIssueEndpoint: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; issue_number: number; owner: string; repo: string } & RequiredPreview<"squirrel-girl">

ReactionsCreateForIssueRequestOptions

ReactionsCreateForIssueRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/reactions" }

Type declaration

ReactionsCreateForPullRequestReviewCommentEndpoint

ReactionsCreateForPullRequestReviewCommentEndpoint: { comment_id: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; repo: string } & RequiredPreview<"squirrel-girl">

ReactionsCreateForPullRequestReviewCommentRequestOptions

ReactionsCreateForPullRequestReviewCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions" }

Type declaration

ReactionsCreateForTeamDiscussionCommentInOrgEndpoint

ReactionsCreateForTeamDiscussionCommentInOrgEndpoint: { comment_number: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; team_slug: string } & RequiredPreview<"squirrel-girl">

ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions

ReactionsCreateForTeamDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions" }

Type declaration

ReactionsCreateForTeamDiscussionCommentLegacyEndpoint

ReactionsCreateForTeamDiscussionCommentLegacyEndpoint: { comment_number: number; content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; team_id: number } & RequiredPreview<"squirrel-girl">

ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions

ReactionsCreateForTeamDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions" }

Type declaration

ReactionsCreateForTeamDiscussionInOrgEndpoint

ReactionsCreateForTeamDiscussionInOrgEndpoint: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; team_slug: string } & RequiredPreview<"squirrel-girl">

ReactionsCreateForTeamDiscussionInOrgRequestOptions

ReactionsCreateForTeamDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions" }

Type declaration

ReactionsCreateForTeamDiscussionLegacyEndpoint

ReactionsCreateForTeamDiscussionLegacyEndpoint: { content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; team_id: number } & RequiredPreview<"squirrel-girl">

ReactionsCreateForTeamDiscussionLegacyRequestOptions

ReactionsCreateForTeamDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/reactions" }

Type declaration

ReactionsDeleteForCommitCommentEndpoint

ReactionsDeleteForCommitCommentEndpoint: { comment_id: number; owner: string; reaction_id: number; repo: string } & RequiredPreview<"squirrel-girl">

ReactionsDeleteForCommitCommentRequestOptions

ReactionsDeleteForCommitCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id" }

Type declaration

ReactionsDeleteForIssueCommentEndpoint

ReactionsDeleteForIssueCommentEndpoint: { comment_id: number; owner: string; reaction_id: number; repo: string } & RequiredPreview<"squirrel-girl">

ReactionsDeleteForIssueCommentRequestOptions

ReactionsDeleteForIssueCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions/:reaction_id" }

Type declaration

ReactionsDeleteForIssueEndpoint

ReactionsDeleteForIssueEndpoint: { issue_number: number; owner: string; reaction_id: number; repo: string } & RequiredPreview<"squirrel-girl">

ReactionsDeleteForIssueRequestOptions

ReactionsDeleteForIssueRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/reactions/:reaction_id" }

Type declaration

ReactionsDeleteForPullRequestCommentEndpoint

ReactionsDeleteForPullRequestCommentEndpoint: { comment_id: number; owner: string; reaction_id: number; repo: string } & RequiredPreview<"squirrel-girl">

ReactionsDeleteForPullRequestCommentRequestOptions

ReactionsDeleteForPullRequestCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id" }

Type declaration

ReactionsDeleteForTeamDiscussionCommentEndpoint

ReactionsDeleteForTeamDiscussionCommentEndpoint: { comment_number: number; discussion_number: number; org: string; reaction_id: number; team_slug: string } & RequiredPreview<"squirrel-girl">

ReactionsDeleteForTeamDiscussionCommentRequestOptions

ReactionsDeleteForTeamDiscussionCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id" }

Type declaration

  • headers: RequestHeaders
  • method: "DELETE"
  • request: RequestRequestOptions
  • url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id"

ReactionsDeleteForTeamDiscussionEndpoint

ReactionsDeleteForTeamDiscussionEndpoint: { discussion_number: number; org: string; reaction_id: number; team_slug: string } & RequiredPreview<"squirrel-girl">

ReactionsDeleteForTeamDiscussionRequestOptions

ReactionsDeleteForTeamDiscussionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions/:reaction_id" }

Type declaration

ReactionsDeleteLegacyEndpoint

ReactionsDeleteLegacyEndpoint: { reaction_id: number } & RequiredPreview<"squirrel-girl">

ReactionsDeleteLegacyRequestOptions

ReactionsDeleteLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/reactions/:reaction_id" }

Type declaration

ReactionsListForCommitCommentEndpoint

ReactionsListForCommitCommentEndpoint: { comment_id: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string } & RequiredPreview<"squirrel-girl">

ReactionsListForCommitCommentRequestOptions

ReactionsListForCommitCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments/:comment_id/reactions" }

Type declaration

ReactionsListForCommitCommentResponseData

ReactionsListForCommitCommentResponseData: { content: string; created_at: string; id: number; node_id: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

ReactionsListForIssueCommentEndpoint

ReactionsListForIssueCommentEndpoint: { comment_id: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string } & RequiredPreview<"squirrel-girl">

ReactionsListForIssueCommentRequestOptions

ReactionsListForIssueCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions" }

Type declaration

ReactionsListForIssueCommentResponseData

ReactionsListForIssueCommentResponseData: { content: string; created_at: string; id: number; node_id: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

ReactionsListForIssueEndpoint

ReactionsListForIssueEndpoint: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; issue_number: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string } & RequiredPreview<"squirrel-girl">

ReactionsListForIssueRequestOptions

ReactionsListForIssueRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/issues/:issue_number/reactions" }

Type declaration

ReactionsListForIssueResponseData

ReactionsListForIssueResponseData: { content: string; created_at: string; id: number; node_id: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

ReactionsListForPullRequestReviewCommentEndpoint

ReactionsListForPullRequestReviewCommentEndpoint: { comment_id: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string } & RequiredPreview<"squirrel-girl">

ReactionsListForPullRequestReviewCommentRequestOptions

ReactionsListForPullRequestReviewCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions" }

Type declaration

ReactionsListForPullRequestReviewCommentResponseData

ReactionsListForPullRequestReviewCommentResponseData: { content: string; created_at: string; id: number; node_id: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

ReactionsListForTeamDiscussionCommentInOrgEndpoint

ReactionsListForTeamDiscussionCommentInOrgEndpoint: { comment_number: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string } & RequiredPreview<"squirrel-girl">

ReactionsListForTeamDiscussionCommentInOrgRequestOptions

ReactionsListForTeamDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions" }

Type declaration

ReactionsListForTeamDiscussionCommentInOrgResponseData

ReactionsListForTeamDiscussionCommentInOrgResponseData: { content: string; created_at: string; id: number; node_id: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

ReactionsListForTeamDiscussionCommentLegacyEndpoint

ReactionsListForTeamDiscussionCommentLegacyEndpoint: { comment_number: number; content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; page?: undefined | number; per_page?: undefined | number; team_id: number } & RequiredPreview<"squirrel-girl">

ReactionsListForTeamDiscussionCommentLegacyRequestOptions

ReactionsListForTeamDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions" }

Type declaration

ReactionsListForTeamDiscussionCommentLegacyResponseData

ReactionsListForTeamDiscussionCommentLegacyResponseData: { content: string; created_at: string; id: number; node_id: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

ReactionsListForTeamDiscussionInOrgEndpoint

ReactionsListForTeamDiscussionInOrgEndpoint: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string } & RequiredPreview<"squirrel-girl">

ReactionsListForTeamDiscussionInOrgRequestOptions

ReactionsListForTeamDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions" }

Type declaration

ReactionsListForTeamDiscussionInOrgResponseData

ReactionsListForTeamDiscussionInOrgResponseData: { content: string; created_at: string; id: number; node_id: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

ReactionsListForTeamDiscussionLegacyEndpoint

ReactionsListForTeamDiscussionLegacyEndpoint: { content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; discussion_number: number; page?: undefined | number; per_page?: undefined | number; team_id: number } & RequiredPreview<"squirrel-girl">

ReactionsListForTeamDiscussionLegacyRequestOptions

ReactionsListForTeamDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/reactions" }

Type declaration

ReactionsListForTeamDiscussionLegacyResponseData

ReactionsListForTeamDiscussionLegacyResponseData: { content: string; created_at: string; id: number; node_id: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

ReposAcceptInvitationEndpoint

ReposAcceptInvitationEndpoint: { invitation_id: number }

Type declaration

  • invitation_id: number

ReposAcceptInvitationRequestOptions

ReposAcceptInvitationRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/user/repository_invitations/:invitation_id" }

Type declaration

ReposAddAppAccessRestrictionsEndpoint

ReposAddAppAccessRestrictionsEndpoint: { apps: string[]; branch: string; owner: string; repo: string }

Type declaration

  • apps: string[]

    apps parameter

  • branch: string
  • owner: string
  • repo: string

ReposAddAppAccessRestrictionsRequestOptions

ReposAddAppAccessRestrictionsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" }

Type declaration

ReposAddAppAccessRestrictionsResponseData

ReposAddAppAccessRestrictionsResponseData: { created_at: string; description: string; events: string[]; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }; permissions: { contents: string; issues: string; metadata: string; single_file: string }; slug: string; updated_at: string }[]

ReposAddCollaboratorEndpoint

ReposAddCollaboratorEndpoint: { owner: string; permission?: "pull" | "push" | "admin" | "maintain" | "triage"; repo: string; username: string }

Type declaration

  • owner: string
  • Optional permission?: "pull" | "push" | "admin" | "maintain" | "triage"

    The permission to grant the collaborator. Only valid on organization-owned repositories. Can be one of: * pull - can pull, but not push to or administer this repository. * push - can pull and push, but not administer this repository. * admin - can pull, push and administer this repository. * maintain - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. * triage - Recommended for contributors who need to proactively manage issues and pull requests without write access.

  • repo: string
  • username: string

ReposAddCollaboratorRequestOptions

ReposAddCollaboratorRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/collaborators/:username" }

Type declaration

ReposAddStatusCheckContextsEndpoint

ReposAddStatusCheckContextsEndpoint: { branch: string; contexts: string[]; owner: string; repo: string }

Type declaration

  • branch: string
  • contexts: string[]

    contexts parameter

  • owner: string
  • repo: string

ReposAddStatusCheckContextsRequestOptions

ReposAddStatusCheckContextsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" }

Type declaration

ReposAddStatusCheckContextsResponseData

ReposAddStatusCheckContextsResponseData: string[]

ReposAddTeamAccessRestrictionsEndpoint

ReposAddTeamAccessRestrictionsEndpoint: { branch: string; owner: string; repo: string; teams: string[] }

Type declaration

  • branch: string
  • owner: string
  • repo: string
  • teams: string[]

    teams parameter

ReposAddTeamAccessRestrictionsRequestOptions

ReposAddTeamAccessRestrictionsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" }

Type declaration

ReposAddTeamAccessRestrictionsResponseData

ReposAddTeamAccessRestrictionsResponseData: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: {}; permission: string; privacy: string; repositories_url: string; slug: string; url: string }[]

ReposAddUserAccessRestrictionsEndpoint

ReposAddUserAccessRestrictionsEndpoint: { branch: string; owner: string; repo: string; users: string[] }

Type declaration

  • branch: string
  • owner: string
  • repo: string
  • users: string[]

    users parameter

ReposAddUserAccessRestrictionsRequestOptions

ReposAddUserAccessRestrictionsRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" }

Type declaration

ReposAddUserAccessRestrictionsResponseData

ReposAddUserAccessRestrictionsResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

ReposCheckCollaboratorEndpoint

ReposCheckCollaboratorEndpoint: { owner: string; repo: string; username: string }

Type declaration

  • owner: string
  • repo: string
  • username: string

ReposCheckCollaboratorRequestOptions

ReposCheckCollaboratorRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/collaborators/:username" }

Type declaration

ReposCheckVulnerabilityAlertsEndpoint

ReposCheckVulnerabilityAlertsEndpoint: { owner: string; repo: string } & RequiredPreview<"dorian">

ReposCheckVulnerabilityAlertsRequestOptions

ReposCheckVulnerabilityAlertsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/vulnerability-alerts" }

Type declaration

ReposCompareCommitsEndpoint

ReposCompareCommitsEndpoint: { base: string; head: string; owner: string; repo: string }

Type declaration

  • base: string
  • head: string
  • owner: string
  • repo: string

ReposCompareCommitsRequestOptions

ReposCompareCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/compare/:base...:head" }

Type declaration

ReposCreateCommitCommentEndpoint

ReposCreateCommitCommentEndpoint: { body: string; commit_sha: string; line?: number | null; owner: string; path?: undefined | string; position?: undefined | number; repo: string }

Type declaration

  • body: string

    The contents of the comment.

  • commit_sha: string
  • Optional line?: number | null

    Deprecated. Use position parameter instead. Line number in the file to comment on.

  • owner: string
  • Optional path?: undefined | string

    Relative path of the file to comment on.

  • Optional position?: undefined | number

    Line index in the diff to comment on.

  • repo: string

ReposCreateCommitCommentRequestOptions

ReposCreateCommitCommentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:commit_sha/comments" }

Type declaration

ReposCreateCommitSignatureProtectionEndpoint

ReposCreateCommitSignatureProtectionEndpoint: { branch: string; owner: string; repo: string } & RequiredPreview<"zzzax">

ReposCreateCommitSignatureProtectionRequestOptions

ReposCreateCommitSignatureProtectionRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures" }

Type declaration

ReposCreateCommitStatusEndpoint

ReposCreateCommitStatusEndpoint: { context?: undefined | string; description?: undefined | string; owner: string; repo: string; sha: string; state: "error" | "failure" | "pending" | "success"; target_url?: undefined | string }

Type declaration

  • Optional context?: undefined | string

    A string label to differentiate this status from the status of other systems.

  • Optional description?: undefined | string

    A short description of the status.

  • owner: string
  • repo: string
  • sha: string
  • state: "error" | "failure" | "pending" | "success"

    The state of the status. Can be one of error, failure, pending, or success.

  • Optional target_url?: undefined | string

    The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. For example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: http://ci.example.com/user/repo/build/sha

ReposCreateCommitStatusRequestOptions

ReposCreateCommitStatusRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/statuses/:sha" }

Type declaration

ReposCreateDeployKeyEndpoint

ReposCreateDeployKeyEndpoint: { key: string; owner: string; read_only?: undefined | false | true; repo: string; title?: undefined | string }

Type declaration

  • key: string

    The contents of the key.

  • owner: string
  • Optional read_only?: undefined | false | true

    If true, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.

    Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "Repository permission levels for an organization" and "Permission levels for a user account repository."

  • repo: string
  • Optional title?: undefined | string

    A name for the key.

ReposCreateDeployKeyRequestOptions

ReposCreateDeployKeyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/keys" }

Type declaration

ReposCreateDeploymentEndpoint

ReposCreateDeploymentEndpoint: { auto_merge?: undefined | false | true; description?: undefined | string; environment?: undefined | string; owner: string; payload?: any; production_environment?: undefined | false | true; ref: string; repo: string; required_contexts?: string[]; task?: undefined | string; transient_environment?: undefined | false | true }

Type declaration

  • Optional auto_merge?: undefined | false | true

    Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.

  • Optional description?: undefined | string

    Short description of the deployment.

  • Optional environment?: undefined | string

    Name for the target deployment environment (e.g., production, staging, qa).

  • owner: string
  • Optional payload?: any

    JSON payload with extra information about the deployment.

  • Optional production_environment?: undefined | false | true

    Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • ref: string

    The ref to deploy. This can be a branch, tag, or SHA.

  • repo: string
  • Optional required_contexts?: string[]

    The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

  • Optional task?: undefined | string

    Specifies a task to execute (e.g., deploy or deploy:migrations).

  • Optional transient_environment?: undefined | false | true

    Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

ReposCreateDeploymentRequestOptions

ReposCreateDeploymentRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments" }

Type declaration

ReposCreateDeploymentStatusEndpoint

ReposCreateDeploymentStatusEndpoint: { auto_inactive?: undefined | false | true; deployment_id: number; description?: undefined | string; environment?: "production" | "staging" | "qa"; environment_url?: undefined | string; log_url?: undefined | string; owner: string; repo: string; state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"; target_url?: undefined | string }

Type declaration

  • Optional auto_inactive?: undefined | false | true

    Adds a new inactive status to all prior non-transient, non-production environment deployments with the same repository and environment name as the created status's deployment. An inactive status is only added to deployments that had a success state. Default: true Note: To add an inactive status to production environments, you must use the application/vnd.github.flash-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • deployment_id: number
  • Optional description?: undefined | string

    A short description of the status. The maximum description length is 140 characters.

  • Optional environment?: "production" | "staging" | "qa"

    Name for the target deployment environment, which can be changed when setting a deploy status. For example, production, staging, or qa. Note: This parameter requires you to use the application/vnd.github.flash-preview+json custom media type.

  • Optional environment_url?: undefined | string

    Sets the URL for accessing your environment. Default: "" Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • Optional log_url?: undefined | string

    The full URL of the deployment's output. This parameter replaces target_url. We will continue to accept target_url to support legacy uses, but we recommend replacing target_url with log_url. Setting log_url will automatically set target_url to the same value. Default: "" Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type. Note: This parameter requires you to use the application/vnd.github.ant-man-preview+json custom media type.

  • owner: string
  • repo: string
  • state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success"

    The state of the status. Can be one of error, failure, inactive, in_progress, queued pending, or success. Note: To use the inactive state, you must provide the application/vnd.github.ant-man-preview+json custom media type. To use the in_progress and queued states, you must provide the application/vnd.github.flash-preview+json custom media type. When you set a transient deployment to inactive, the deployment will be shown as destroyed in GitHub.

  • Optional target_url?: undefined | string

    The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. Note: It's recommended to use the log_url parameter, which replaces target_url.

ReposCreateDeploymentStatusRequestOptions

ReposCreateDeploymentStatusRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments/:deployment_id/statuses" }

Type declaration

ReposCreateDispatchEventEndpoint

ReposCreateDispatchEventEndpoint: { client_payload?: ReposCreateDispatchEventParamsClientPayload; event_type: string; owner: string; repo: string }

Type declaration

  • Optional client_payload?: ReposCreateDispatchEventParamsClientPayload

    JSON payload with extra information about the webhook event that your action or worklow may use.

  • event_type: string

    Required: A custom webhook event name.

  • owner: string
  • repo: string

ReposCreateDispatchEventParamsClientPayload

ReposCreateDispatchEventParamsClientPayload: {}

Type declaration

ReposCreateDispatchEventParamsClientPayloadKeyString

ReposCreateDispatchEventParamsClientPayloadKeyString: {}

Type declaration

ReposCreateDispatchEventRequestOptions

ReposCreateDispatchEventRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/dispatches" }

Type declaration

ReposCreateForAuthenticatedUserEndpoint

ReposCreateForAuthenticatedUserEndpoint: { allow_merge_commit?: undefined | false | true; allow_rebase_merge?: undefined | false | true; allow_squash_merge?: undefined | false | true; auto_init?: undefined | false | true; delete_branch_on_merge?: undefined | false | true; description?: undefined | string; gitignore_template?: undefined | string; has_issues?: undefined | false | true; has_projects?: undefined | false | true; has_wiki?: undefined | false | true; homepage?: undefined | string; is_template?: undefined | false | true; license_template?: undefined | string; name: string; private?: undefined | false | true; team_id?: undefined | number; visibility?: "public" | "private" | "visibility" | "internal" }

Type declaration

  • Optional allow_merge_commit?: undefined | false | true

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

  • Optional allow_rebase_merge?: undefined | false | true

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

  • Optional allow_squash_merge?: undefined | false | true

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

  • Optional auto_init?: undefined | false | true

    Pass true to create an initial commit with empty README.

  • Optional delete_branch_on_merge?: undefined | false | true

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

  • Optional description?: undefined | string

    A short description of the repository.

  • Optional gitignore_template?: undefined | string

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".

  • Optional has_issues?: undefined | false | true

    Either true to enable issues for this repository or false to disable them.

  • Optional has_projects?: undefined | false | true

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

  • Optional has_wiki?: undefined | false | true

    Either true to enable the wiki for this repository or false to disable it.

  • Optional homepage?: undefined | string

    A URL with more information about the repository.

  • Optional is_template?: undefined | false | true

    Either true to make this repo available as a template repository or false to prevent it.

  • Optional license_template?: undefined | string

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".

  • name: string

    The name of the repository.

  • Optional private?: undefined | false | true

    Either true to create a private repository or false to create a public one.

  • Optional team_id?: undefined | number

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

  • Optional visibility?: "public" | "private" | "visibility" | "internal"

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see "Creating an internal repository". The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

ReposCreateForAuthenticatedUserRequestOptions

ReposCreateForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/user/repos" }

Type declaration

ReposCreateForkEndpoint

ReposCreateForkEndpoint: { organization?: undefined | string; owner: string; repo: string }

Type declaration

  • Optional organization?: undefined | string

    Optional parameter to specify the organization name if forking into an organization.

  • owner: string
  • repo: string

ReposCreateForkRequestOptions

ReposCreateForkRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/forks" }

Type declaration

ReposCreateInOrgEndpoint

ReposCreateInOrgEndpoint: { allow_merge_commit?: undefined | false | true; allow_rebase_merge?: undefined | false | true; allow_squash_merge?: undefined | false | true; auto_init?: undefined | false | true; delete_branch_on_merge?: undefined | false | true; description?: undefined | string; gitignore_template?: undefined | string; has_issues?: undefined | false | true; has_projects?: undefined | false | true; has_wiki?: undefined | false | true; homepage?: undefined | string; is_template?: undefined | false | true; license_template?: undefined | string; name: string; org: string; private?: undefined | false | true; team_id?: undefined | number; visibility?: "public" | "private" | "visibility" | "internal" }

Type declaration

  • Optional allow_merge_commit?: undefined | false | true

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

  • Optional allow_rebase_merge?: undefined | false | true

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

  • Optional allow_squash_merge?: undefined | false | true

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

  • Optional auto_init?: undefined | false | true

    Pass true to create an initial commit with empty README.

  • Optional delete_branch_on_merge?: undefined | false | true

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

  • Optional description?: undefined | string

    A short description of the repository.

  • Optional gitignore_template?: undefined | string

    Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, "Haskell".

  • Optional has_issues?: undefined | false | true

    Either true to enable issues for this repository or false to disable them.

  • Optional has_projects?: undefined | false | true

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

  • Optional has_wiki?: undefined | false | true

    Either true to enable the wiki for this repository or false to disable it.

  • Optional homepage?: undefined | string

    A URL with more information about the repository.

  • Optional is_template?: undefined | false | true

    Either true to make this repo available as a template repository or false to prevent it.

  • Optional license_template?: undefined | string

    Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, "mit" or "mpl-2.0".

  • name: string

    The name of the repository.

  • org: string
  • Optional private?: undefined | false | true

    Either true to create a private repository or false to create a public one.

  • Optional team_id?: undefined | number

    The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

  • Optional visibility?: "public" | "private" | "visibility" | "internal"

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see "Creating an internal repository". The visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

ReposCreateInOrgRequestOptions

ReposCreateInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/repos" }

Type declaration

ReposCreateOrUpdateFileContentsEndpoint

ReposCreateOrUpdateFileContentsEndpoint: { author?: ReposCreateOrUpdateFileContentsParamsAuthor; branch?: undefined | string; committer?: ReposCreateOrUpdateFileContentsParamsCommitter; content: string; message: string; owner: string; path: string; repo: string; sha?: undefined | string }

Type declaration

  • Optional author?: ReposCreateOrUpdateFileContentsParamsAuthor

    The author of the file. Default: The committer or the authenticated user if you omit committer.

  • Optional branch?: undefined | string

    The branch name. Default: the repository’s default branch (usually master)

  • Optional committer?: ReposCreateOrUpdateFileContentsParamsCommitter

    The person that committed the file. Default: the authenticated user.

  • content: string

    The new file content, using Base64 encoding.

  • message: string

    The commit message.

  • owner: string
  • path: string
  • repo: string
  • Optional sha?: undefined | string

    Required if you are updating a file. The blob SHA of the file being replaced.

ReposCreateOrUpdateFileContentsParamsAuthor

ReposCreateOrUpdateFileContentsParamsAuthor: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ReposCreateOrUpdateFileContentsParamsCommitter

ReposCreateOrUpdateFileContentsParamsCommitter: { email: string; name: string }

Type declaration

  • email: string
  • name: string

ReposCreateOrUpdateFileContentsRequestOptions

ReposCreateOrUpdateFileContentsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/contents/:path" }

Type declaration

ReposCreatePagesSiteEndpoint

ReposCreatePagesSiteEndpoint: { owner: string; repo: string; source?: ReposCreatePagesSiteParamsSource } & RequiredPreview<"switcheroo">

ReposCreatePagesSiteParamsSource

ReposCreatePagesSiteParamsSource: { branch?: "master" | "gh-pages"; path?: undefined | string }

Type declaration

  • Optional branch?: "master" | "gh-pages"
  • Optional path?: undefined | string

ReposCreatePagesSiteRequestOptions

ReposCreatePagesSiteRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages" }

Type declaration

ReposCreateReleaseEndpoint

ReposCreateReleaseEndpoint: { body?: undefined | string; draft?: undefined | false | true; name?: undefined | string; owner: string; prerelease?: undefined | false | true; repo: string; tag_name: string; target_commitish?: undefined | string }

Type declaration

  • Optional body?: undefined | string

    Text describing the contents of the tag.

  • Optional draft?: undefined | false | true

    true to create a draft (unpublished) release, false to create a published one.

  • Optional name?: undefined | string

    The name of the release.

  • owner: string
  • Optional prerelease?: undefined | false | true

    true to identify the release as a prerelease. false to identify the release as a full release.

  • repo: string
  • tag_name: string

    The name of the tag.

  • Optional target_commitish?: undefined | string

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

ReposCreateReleaseRequestOptions

ReposCreateReleaseRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases" }

Type declaration

ReposCreateUsingTemplateEndpoint

ReposCreateUsingTemplateEndpoint: { description?: undefined | string; name: string; owner?: undefined | string; private?: undefined | false | true; template_owner: string; template_repo: string } & RequiredPreview<"baptiste">

ReposCreateUsingTemplateRequestOptions

ReposCreateUsingTemplateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:template_owner/:template_repo/generate" }

Type declaration

ReposCreateWebhookEndpoint

ReposCreateWebhookEndpoint: { active?: undefined | false | true; config: ReposCreateWebhookParamsConfig; events?: string[]; name?: undefined | string; owner: string; repo: string }

Type declaration

  • Optional active?: undefined | false | true

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • config: ReposCreateWebhookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for.

  • Optional name?: undefined | string

    Use web to create a webhook. Default: web. This parameter only accepts the value web.

  • owner: string
  • repo: string

ReposCreateWebhookParamsConfig

ReposCreateWebhookParamsConfig: { content_type?: undefined | string; insecure_ssl?: undefined | string; secret?: undefined | string; url: string }

Type declaration

  • Optional content_type?: undefined | string
  • Optional insecure_ssl?: undefined | string
  • Optional secret?: undefined | string
  • url: string

ReposCreateWebhookRequestOptions

ReposCreateWebhookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks" }

Type declaration

ReposDeclineInvitationEndpoint

ReposDeclineInvitationEndpoint: { invitation_id: number }

Type declaration

  • invitation_id: number

ReposDeclineInvitationRequestOptions

ReposDeclineInvitationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/repository_invitations/:invitation_id" }

Type declaration

ReposDeleteAccessRestrictionsEndpoint

ReposDeleteAccessRestrictionsEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposDeleteAccessRestrictionsRequestOptions

ReposDeleteAccessRestrictionsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions" }

Type declaration

ReposDeleteAdminBranchProtectionEndpoint

ReposDeleteAdminBranchProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposDeleteAdminBranchProtectionRequestOptions

ReposDeleteAdminBranchProtectionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" }

Type declaration

ReposDeleteBranchProtectionEndpoint

ReposDeleteBranchProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposDeleteBranchProtectionRequestOptions

ReposDeleteBranchProtectionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection" }

Type declaration

ReposDeleteCommitCommentEndpoint

ReposDeleteCommitCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number
  • owner: string
  • repo: string

ReposDeleteCommitCommentRequestOptions

ReposDeleteCommitCommentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments/:comment_id" }

Type declaration

ReposDeleteCommitSignatureProtectionEndpoint

ReposDeleteCommitSignatureProtectionEndpoint: { branch: string; owner: string; repo: string } & RequiredPreview<"zzzax">

ReposDeleteCommitSignatureProtectionRequestOptions

ReposDeleteCommitSignatureProtectionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures" }

Type declaration

ReposDeleteDeployKeyEndpoint

ReposDeleteDeployKeyEndpoint: { key_id: number; owner: string; repo: string }

Type declaration

  • key_id: number
  • owner: string
  • repo: string

ReposDeleteDeployKeyRequestOptions

ReposDeleteDeployKeyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/keys/:key_id" }

Type declaration

ReposDeleteDeploymentEndpoint

ReposDeleteDeploymentEndpoint: { deployment_id: number; owner: string; repo: string }

Type declaration

  • deployment_id: number
  • owner: string
  • repo: string

ReposDeleteDeploymentRequestOptions

ReposDeleteDeploymentRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments/:deployment_id" }

Type declaration

ReposDeleteEndpoint

ReposDeleteEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposDeleteFileEndpoint

ReposDeleteFileEndpoint: { author?: ReposDeleteFileParamsAuthor; branch?: undefined | string; committer?: ReposDeleteFileParamsCommitter; message: string; owner: string; path: string; repo: string; sha: string }

Type declaration

  • Optional author?: ReposDeleteFileParamsAuthor

    object containing information about the author.

  • Optional branch?: undefined | string

    The branch name. Default: the repository’s default branch (usually master)

  • Optional committer?: ReposDeleteFileParamsCommitter

    object containing information about the committer.

  • message: string

    The commit message.

  • owner: string
  • path: string
  • repo: string
  • sha: string

    The blob SHA of the file being replaced.

ReposDeleteFileParamsAuthor

ReposDeleteFileParamsAuthor: { email?: undefined | string; name?: undefined | string }

Type declaration

  • Optional email?: undefined | string
  • Optional name?: undefined | string

ReposDeleteFileParamsCommitter

ReposDeleteFileParamsCommitter: { email?: undefined | string; name?: undefined | string }

Type declaration

  • Optional email?: undefined | string
  • Optional name?: undefined | string

ReposDeleteFileRequestOptions

ReposDeleteFileRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/contents/:path" }

Type declaration

ReposDeleteInvitationEndpoint

ReposDeleteInvitationEndpoint: { invitation_id: number; owner: string; repo: string }

Type declaration

  • invitation_id: number
  • owner: string
  • repo: string

ReposDeleteInvitationRequestOptions

ReposDeleteInvitationRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/invitations/:invitation_id" }

Type declaration

ReposDeletePagesSiteEndpoint

ReposDeletePagesSiteEndpoint: { owner: string; repo: string } & RequiredPreview<"switcheroo">

ReposDeletePagesSiteRequestOptions

ReposDeletePagesSiteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages" }

Type declaration

ReposDeletePullRequestReviewProtectionEndpoint

ReposDeletePullRequestReviewProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposDeletePullRequestReviewProtectionRequestOptions

ReposDeletePullRequestReviewProtectionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" }

Type declaration

ReposDeleteReleaseAssetEndpoint

ReposDeleteReleaseAssetEndpoint: { asset_id: number; owner: string; repo: string }

Type declaration

  • asset_id: number
  • owner: string
  • repo: string

ReposDeleteReleaseAssetRequestOptions

ReposDeleteReleaseAssetRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/assets/:asset_id" }

Type declaration

ReposDeleteReleaseEndpoint

ReposDeleteReleaseEndpoint: { owner: string; release_id: number; repo: string }

Type declaration

  • owner: string
  • release_id: number
  • repo: string

ReposDeleteReleaseRequestOptions

ReposDeleteReleaseRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/:release_id" }

Type declaration

ReposDeleteRequestOptions

ReposDeleteRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo" }

Type declaration

ReposDeleteWebhookEndpoint

ReposDeleteWebhookEndpoint: { hook_id: number; owner: string; repo: string }

Type declaration

  • hook_id: number
  • owner: string
  • repo: string

ReposDeleteWebhookRequestOptions

ReposDeleteWebhookRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks/:hook_id" }

Type declaration

ReposDisableAutomatedSecurityFixesEndpoint

ReposDisableAutomatedSecurityFixesEndpoint: { owner: string; repo: string } & RequiredPreview<"london">

ReposDisableAutomatedSecurityFixesRequestOptions

ReposDisableAutomatedSecurityFixesRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/automated-security-fixes" }

Type declaration

ReposDisableVulnerabilityAlertsEndpoint

ReposDisableVulnerabilityAlertsEndpoint: { owner: string; repo: string } & RequiredPreview<"dorian">

ReposDisableVulnerabilityAlertsRequestOptions

ReposDisableVulnerabilityAlertsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/vulnerability-alerts" }

Type declaration

ReposDownloadArchiveEndpoint

ReposDownloadArchiveEndpoint: { archive_format: string; owner: string; ref: string; repo: string }

Type declaration

  • archive_format: string
  • owner: string
  • ref: string
  • repo: string

ReposDownloadArchiveRequestOptions

ReposDownloadArchiveRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/:archive_format/:ref" }

Type declaration

ReposEnableAutomatedSecurityFixesEndpoint

ReposEnableAutomatedSecurityFixesEndpoint: { owner: string; repo: string } & RequiredPreview<"london">

ReposEnableAutomatedSecurityFixesRequestOptions

ReposEnableAutomatedSecurityFixesRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/automated-security-fixes" }

Type declaration

ReposEnableVulnerabilityAlertsEndpoint

ReposEnableVulnerabilityAlertsEndpoint: { owner: string; repo: string } & RequiredPreview<"dorian">

ReposEnableVulnerabilityAlertsRequestOptions

ReposEnableVulnerabilityAlertsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/vulnerability-alerts" }

Type declaration

ReposGetAccessRestrictionsEndpoint

ReposGetAccessRestrictionsEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetAccessRestrictionsRequestOptions

ReposGetAccessRestrictionsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions" }

Type declaration

ReposGetAdminBranchProtectionEndpoint

ReposGetAdminBranchProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetAdminBranchProtectionRequestOptions

ReposGetAdminBranchProtectionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" }

Type declaration

ReposGetAllStatusCheckContextsEndpoint

ReposGetAllStatusCheckContextsEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetAllStatusCheckContextsRequestOptions

ReposGetAllStatusCheckContextsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" }

Type declaration

ReposGetAllStatusCheckContextsResponseData

ReposGetAllStatusCheckContextsResponseData: string[]

ReposGetAllTopicsEndpoint

ReposGetAllTopicsEndpoint: { owner: string; repo: string } & RequiredPreview<"mercy">

ReposGetAllTopicsRequestOptions

ReposGetAllTopicsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/topics" }

Type declaration

ReposGetAppsWithAccessToProtectedBranchEndpoint

ReposGetAppsWithAccessToProtectedBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetAppsWithAccessToProtectedBranchRequestOptions

ReposGetAppsWithAccessToProtectedBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" }

Type declaration

ReposGetAppsWithAccessToProtectedBranchResponseData

ReposGetAppsWithAccessToProtectedBranchResponseData: { created_at: string; description: string; events: string[]; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }; permissions: { contents: string; issues: string; metadata: string; single_file: string }; slug: string; updated_at: string }[]

ReposGetBranchEndpoint

ReposGetBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetBranchProtectionEndpoint

ReposGetBranchProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetBranchProtectionRequestOptions

ReposGetBranchProtectionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection" }

Type declaration

ReposGetBranchRequestOptions

ReposGetBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch" }

Type declaration

ReposGetClonesEndpoint

ReposGetClonesEndpoint: { owner: string; per?: "day" | "week"; repo: string }

Type declaration

  • owner: string
  • Optional per?: "day" | "week"

    Must be one of: day, week.

  • repo: string

ReposGetClonesRequestOptions

ReposGetClonesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/traffic/clones" }

Type declaration

ReposGetCodeFrequencyStatsEndpoint

ReposGetCodeFrequencyStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposGetCodeFrequencyStatsRequestOptions

ReposGetCodeFrequencyStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/stats/code_frequency" }

Type declaration

ReposGetCodeFrequencyStatsResponseData

ReposGetCodeFrequencyStatsResponseData: number[][]

ReposGetCollaboratorPermissionLevelEndpoint

ReposGetCollaboratorPermissionLevelEndpoint: { owner: string; repo: string; username: string }

Type declaration

  • owner: string
  • repo: string
  • username: string

ReposGetCollaboratorPermissionLevelRequestOptions

ReposGetCollaboratorPermissionLevelRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/collaborators/:username/permission" }

Type declaration

ReposGetCombinedStatusForRefEndpoint

ReposGetCombinedStatusForRefEndpoint: { owner: string; ref: string; repo: string }

Type declaration

  • owner: string
  • ref: string
  • repo: string

ReposGetCombinedStatusForRefRequestOptions

ReposGetCombinedStatusForRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:ref/status" }

Type declaration

ReposGetCommitActivityStatsEndpoint

ReposGetCommitActivityStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposGetCommitActivityStatsRequestOptions

ReposGetCommitActivityStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/stats/commit_activity" }

Type declaration

ReposGetCommitActivityStatsResponseData

ReposGetCommitActivityStatsResponseData: { days: number[]; total: number; week: number }[]

ReposGetCommitCommentEndpoint

ReposGetCommitCommentEndpoint: { comment_id: number; owner: string; repo: string }

Type declaration

  • comment_id: number
  • owner: string
  • repo: string

ReposGetCommitCommentRequestOptions

ReposGetCommitCommentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments/:comment_id" }

Type declaration

ReposGetCommitEndpoint

ReposGetCommitEndpoint: { owner: string; ref: string; repo: string }

Type declaration

  • owner: string
  • ref: string
  • repo: string

ReposGetCommitRequestOptions

ReposGetCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:ref" }

Type declaration

ReposGetCommitSignatureProtectionEndpoint

ReposGetCommitSignatureProtectionEndpoint: { branch: string; owner: string; repo: string } & RequiredPreview<"zzzax">

ReposGetCommitSignatureProtectionRequestOptions

ReposGetCommitSignatureProtectionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures" }

Type declaration

ReposGetCommunityProfileMetricsEndpoint

ReposGetCommunityProfileMetricsEndpoint: { owner: string; repo: string } & RequiredPreview<"black-panther">

ReposGetCommunityProfileMetricsRequestOptions

ReposGetCommunityProfileMetricsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/community/profile" }

Type declaration

ReposGetContentEndpoint

ReposGetContentEndpoint: { owner: string; path: string; ref?: undefined | string; repo: string }

Type declaration

  • owner: string
  • path: string
  • Optional ref?: undefined | string

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

  • repo: string

ReposGetContentRequestOptions

ReposGetContentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/contents/:path" }

Type declaration

ReposGetContributorsStatsEndpoint

ReposGetContributorsStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposGetContributorsStatsRequestOptions

ReposGetContributorsStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/stats/contributors" }

Type declaration

ReposGetContributorsStatsResponseData

ReposGetContributorsStatsResponseData: { author: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; total: number; weeks: { a: number; c: number; d: number; w: string }[] }[]

ReposGetDeployKeyEndpoint

ReposGetDeployKeyEndpoint: { key_id: number; owner: string; repo: string }

Type declaration

  • key_id: number
  • owner: string
  • repo: string

ReposGetDeployKeyRequestOptions

ReposGetDeployKeyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/keys/:key_id" }

Type declaration

ReposGetDeploymentEndpoint

ReposGetDeploymentEndpoint: { deployment_id: number; owner: string; repo: string }

Type declaration

  • deployment_id: number
  • owner: string
  • repo: string

ReposGetDeploymentRequestOptions

ReposGetDeploymentRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments/:deployment_id" }

Type declaration

ReposGetDeploymentStatusEndpoint

ReposGetDeploymentStatusEndpoint: { deployment_id: number; owner: string; repo: string; status_id: number }

Type declaration

  • deployment_id: number
  • owner: string
  • repo: string
  • status_id: number

ReposGetDeploymentStatusRequestOptions

ReposGetDeploymentStatusRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id" }

Type declaration

ReposGetEndpoint

ReposGetEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposGetLatestPagesBuildEndpoint

ReposGetLatestPagesBuildEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposGetLatestPagesBuildRequestOptions

ReposGetLatestPagesBuildRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages/builds/latest" }

Type declaration

ReposGetLatestReleaseEndpoint

ReposGetLatestReleaseEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposGetLatestReleaseRequestOptions

ReposGetLatestReleaseRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/latest" }

Type declaration

ReposGetPagesBuildEndpoint

ReposGetPagesBuildEndpoint: { build_id: number; owner: string; repo: string }

Type declaration

  • build_id: number
  • owner: string
  • repo: string

ReposGetPagesBuildRequestOptions

ReposGetPagesBuildRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages/builds/:build_id" }

Type declaration

ReposGetPagesEndpoint

ReposGetPagesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposGetPagesRequestOptions

ReposGetPagesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages" }

Type declaration

ReposGetParticipationStatsEndpoint

ReposGetParticipationStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposGetParticipationStatsRequestOptions

ReposGetParticipationStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/stats/participation" }

Type declaration

ReposGetPullRequestReviewProtectionEndpoint

ReposGetPullRequestReviewProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetPullRequestReviewProtectionRequestOptions

ReposGetPullRequestReviewProtectionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" }

Type declaration

ReposGetPunchCardStatsEndpoint

ReposGetPunchCardStatsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposGetPunchCardStatsRequestOptions

ReposGetPunchCardStatsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/stats/punch_card" }

Type declaration

ReposGetPunchCardStatsResponseData

ReposGetPunchCardStatsResponseData: number[][]

ReposGetReadmeEndpoint

ReposGetReadmeEndpoint: { owner: string; ref?: undefined | string; repo: string }

Type declaration

  • owner: string
  • Optional ref?: undefined | string

    The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

  • repo: string

ReposGetReadmeRequestOptions

ReposGetReadmeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/readme" }

Type declaration

ReposGetReleaseAssetEndpoint

ReposGetReleaseAssetEndpoint: { asset_id: number; owner: string; repo: string }

Type declaration

  • asset_id: number
  • owner: string
  • repo: string

ReposGetReleaseAssetRequestOptions

ReposGetReleaseAssetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/assets/:asset_id" }

Type declaration

ReposGetReleaseByTagEndpoint

ReposGetReleaseByTagEndpoint: { owner: string; repo: string; tag: string }

Type declaration

  • owner: string
  • repo: string
  • tag: string

ReposGetReleaseByTagRequestOptions

ReposGetReleaseByTagRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/tags/:tag" }

Type declaration

ReposGetReleaseEndpoint

ReposGetReleaseEndpoint: { owner: string; release_id: number; repo: string }

Type declaration

  • owner: string
  • release_id: number
  • repo: string

ReposGetReleaseRequestOptions

ReposGetReleaseRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/:release_id" }

Type declaration

ReposGetRequestOptions

ReposGetRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo" }

Type declaration

ReposGetStatusChecksProtectionEndpoint

ReposGetStatusChecksProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetStatusChecksProtectionRequestOptions

ReposGetStatusChecksProtectionRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" }

Type declaration

ReposGetTeamsWithAccessToProtectedBranchEndpoint

ReposGetTeamsWithAccessToProtectedBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetTeamsWithAccessToProtectedBranchRequestOptions

ReposGetTeamsWithAccessToProtectedBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" }

Type declaration

ReposGetTeamsWithAccessToProtectedBranchResponseData

ReposGetTeamsWithAccessToProtectedBranchResponseData: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: {}; permission: string; privacy: string; repositories_url: string; slug: string; url: string }[]

ReposGetTopPathsEndpoint

ReposGetTopPathsEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposGetTopPathsRequestOptions

ReposGetTopPathsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/traffic/popular/paths" }

Type declaration

ReposGetTopPathsResponseData

ReposGetTopPathsResponseData: { count: number; path: string; title: string; uniques: number }[]

ReposGetTopReferrersEndpoint

ReposGetTopReferrersEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposGetTopReferrersRequestOptions

ReposGetTopReferrersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/traffic/popular/referrers" }

Type declaration

ReposGetTopReferrersResponseData

ReposGetTopReferrersResponseData: { count: number; referrer: string; uniques: number }[]

ReposGetUsersWithAccessToProtectedBranchEndpoint

ReposGetUsersWithAccessToProtectedBranchEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposGetUsersWithAccessToProtectedBranchRequestOptions

ReposGetUsersWithAccessToProtectedBranchRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" }

Type declaration

ReposGetUsersWithAccessToProtectedBranchResponseData

ReposGetUsersWithAccessToProtectedBranchResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

ReposGetViewsEndpoint

ReposGetViewsEndpoint: { owner: string; per?: "day" | "week"; repo: string }

Type declaration

  • owner: string
  • Optional per?: "day" | "week"

    Must be one of: day, week.

  • repo: string

ReposGetViewsRequestOptions

ReposGetViewsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/traffic/views" }

Type declaration

ReposGetWebhookEndpoint

ReposGetWebhookEndpoint: { hook_id: number; owner: string; repo: string }

Type declaration

  • hook_id: number
  • owner: string
  • repo: string

ReposGetWebhookRequestOptions

ReposGetWebhookRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks/:hook_id" }

Type declaration

ReposListBranchesEndpoint

ReposListBranchesEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; protected?: undefined | false | true; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional protected?: undefined | false | true

    Setting to true returns only protected branches. When set to false, only unprotected branches are returned. Omitting this parameter returns all branches.

  • repo: string

ReposListBranchesForHeadCommitEndpoint

ReposListBranchesForHeadCommitEndpoint: { commit_sha: string; owner: string; repo: string } & RequiredPreview<"groot">

ReposListBranchesForHeadCommitRequestOptions

ReposListBranchesForHeadCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:commit_sha/branches-where-head" }

Type declaration

ReposListBranchesForHeadCommitResponseData

ReposListBranchesForHeadCommitResponseData: { commit: { sha: string; url: string }; name: string; protected: boolean }[]

ReposListBranchesRequestOptions

ReposListBranchesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches" }

Type declaration

ReposListBranchesResponseData

ReposListBranchesResponseData: { commit: { sha: string; url: string }; name: string; protected: boolean; protection: { enabled: boolean; required_status_checks: { contexts: string[]; enforcement_level: string } }; protection_url: string }[]

ReposListCollaboratorsEndpoint

ReposListCollaboratorsEndpoint: { affiliation?: "outside" | "direct" | "all"; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • Optional affiliation?: "outside" | "direct" | "all"

    Filter collaborators returned by their affiliation. Can be one of: * outside: All outside collaborators of an organization-owned repository. * direct: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. * all: All collaborators the authenticated user can see.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListCollaboratorsRequestOptions

ReposListCollaboratorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/collaborators" }

Type declaration

ReposListCollaboratorsResponseData

ReposListCollaboratorsResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; permissions: { admin: boolean; pull: boolean; push: boolean }; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

ReposListCommentsForCommitEndpoint

ReposListCommentsForCommitEndpoint: { commit_sha: string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • commit_sha: string
  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListCommentsForCommitRequestOptions

ReposListCommentsForCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:commit_sha/comments" }

Type declaration

ReposListCommentsForCommitResponseData

ReposListCommentsForCommitResponseData: { body: string; commit_id: string; created_at: string; html_url: string; id: number; line: number; node_id: string; path: string; position: number; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

ReposListCommitCommentsForRepoEndpoint

ReposListCommitCommentsForRepoEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListCommitCommentsForRepoRequestOptions

ReposListCommitCommentsForRepoRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments" }

Type declaration

ReposListCommitCommentsForRepoResponseData

ReposListCommitCommentsForRepoResponseData: { body: string; commit_id: string; created_at: string; html_url: string; id: number; line: number; node_id: string; path: string; position: number; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

ReposListCommitStatusesForRefEndpoint

ReposListCommitStatusesForRefEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; ref: string; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • ref: string
  • repo: string

ReposListCommitStatusesForRefRequestOptions

ReposListCommitStatusesForRefRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:ref/statuses" }

Type declaration

ReposListCommitStatusesForRefResponseData

ReposListCommitStatusesForRefResponseData: { avatar_url: string; context: string; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; description: string; id: number; node_id: string; state: string; target_url: string; updated_at: string; url: string }[]

ReposListCommitsEndpoint

ReposListCommitsEndpoint: { author?: undefined | string; owner: string; page?: undefined | number; path?: undefined | string; per_page?: undefined | number; repo: string; sha?: undefined | string; since?: undefined | string; until?: undefined | string }

Type declaration

  • Optional author?: undefined | string

    GitHub login or email address by which to filter by commit author.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional path?: undefined | string

    Only commits containing this file path will be returned.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional sha?: undefined | string

    SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).

  • Optional since?: undefined | string

    Only commits after this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

  • Optional until?: undefined | string

    Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

ReposListCommitsRequestOptions

ReposListCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits" }

Type declaration

ReposListCommitsResponseData

ReposListCommitsResponseData: { author: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; comments_url: string; commit: { author: { date: string; email: string; name: string }; comment_count: number; committer: { date: string; email: string; name: string }; message: string; tree: { sha: string; url: string }; url: string; verification: { payload: string; reason: string; signature: string; verified: boolean } }; committer: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; html_url: string; node_id: string; parents: { sha: string; url: string }[]; sha: string; url: string }[]

ReposListContributorsEndpoint

ReposListContributorsEndpoint: { anon?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • Optional anon?: undefined | string

    Set to 1 or true to include anonymous contributors in results.

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListContributorsRequestOptions

ReposListContributorsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/contributors" }

Type declaration

ReposListContributorsResponseData

ReposListContributorsResponseData: { avatar_url: string; contributions: number; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

ReposListDeployKeysEndpoint

ReposListDeployKeysEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListDeployKeysRequestOptions

ReposListDeployKeysRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/keys" }

Type declaration

ReposListDeployKeysResponseData

ReposListDeployKeysResponseData: { created_at: string; id: number; key: string; read_only: boolean; title: string; url: string; verified: boolean }[]

ReposListDeploymentStatusesEndpoint

ReposListDeploymentStatusesEndpoint: { deployment_id: number; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • deployment_id: number
  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListDeploymentStatusesRequestOptions

ReposListDeploymentStatusesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments/:deployment_id/statuses" }

Type declaration

ReposListDeploymentStatusesResponseData

ReposListDeploymentStatusesResponseData: { created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; deployment_url: string; description: string; environment: string; environment_url: string; id: number; log_url: string; node_id: string; repository_url: string; state: string; target_url: string; updated_at: string; url: string }[]

ReposListDeploymentsEndpoint

ReposListDeploymentsEndpoint: { environment?: undefined | string; owner: string; page?: undefined | number; per_page?: undefined | number; ref?: undefined | string; repo: string; sha?: undefined | string; task?: undefined | string }

Type declaration

  • Optional environment?: undefined | string

    The name of the environment that was deployed to (e.g., staging or production).

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional ref?: undefined | string

    The name of the ref. This can be a branch, tag, or SHA.

  • repo: string
  • Optional sha?: undefined | string

    The SHA recorded at creation time.

  • Optional task?: undefined | string

    The name of the task for the deployment (e.g., deploy or deploy:migrations).

ReposListDeploymentsRequestOptions

ReposListDeploymentsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/deployments" }

Type declaration

ReposListDeploymentsResponseData

ReposListDeploymentsResponseData: { created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; description: string; environment: string; id: number; node_id: string; original_environment: string; payload: { deploy: string }; production_environment: boolean; ref: string; repository_url: string; sha: string; statuses_url: string; task: string; transient_environment: boolean; updated_at: string; url: string }[]

ReposListForAuthenticatedUserEndpoint

ReposListForAuthenticatedUserEndpoint: { affiliation?: undefined | string; direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "owner" | "public" | "private" | "member"; visibility?: "all" | "public" | "private" }

Type declaration

  • Optional affiliation?: undefined | string

    Comma-separated list of values. Can include: * owner: Repositories that are owned by the authenticated user. * collaborator: Repositories that the user has been added to as a collaborator. * organization_member: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: asc when using full_name, otherwise desc

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "owner" | "public" | "private" | "member"

    Can be one of all, owner, public, private, member. Default: all

    Will cause a 422 error if used in the same request as visibility or affiliation. Will cause a 422 error if used in the same request as visibility or affiliation.

  • Optional visibility?: "all" | "public" | "private"

    Can be one of all, public, or private.

ReposListForAuthenticatedUserRequestOptions

ReposListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/repos" }

Type declaration

ReposListForOrgEndpoint

ReposListForOrgEndpoint: { direction?: "asc" | "desc"; org: string; page?: undefined | number; per_page?: undefined | number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal" }

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: when using full_name: asc, otherwise desc

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "public" | "private" | "forks" | "sources" | "member" | "internal"

    Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

ReposListForOrgRequestOptions

ReposListForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/repos" }

Type declaration

ReposListForOrgResponseData

ReposListForOrgResponseData: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; license: { key: string; name: string; node_id: string; spdx_id: string; url: string }; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }[]

ReposListForUserEndpoint

ReposListForUserEndpoint: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; sort?: "created" | "updated" | "pushed" | "full_name"; type?: "all" | "owner" | "member"; username: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    Can be one of asc or desc. Default: asc when using full_name, otherwise desc

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional sort?: "created" | "updated" | "pushed" | "full_name"

    Can be one of created, updated, pushed, full_name.

  • Optional type?: "all" | "owner" | "member"

    Can be one of all, owner, member.

  • username: string

ReposListForUserRequestOptions

ReposListForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/repos" }

Type declaration

ReposListForksEndpoint

ReposListForksEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string; sort?: "newest" | "oldest" | "stargazers" }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string
  • Optional sort?: "newest" | "oldest" | "stargazers"

    The sort order. Can be either newest, oldest, or stargazers.

ReposListForksRequestOptions

ReposListForksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/forks" }

Type declaration

ReposListForksResponseData

ReposListForksResponseData: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; license: { key: string; name: string; node_id: string; spdx_id: string; url: string }; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }[]

ReposListInvitationsEndpoint

ReposListInvitationsEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListInvitationsForAuthenticatedUserEndpoint

ReposListInvitationsForAuthenticatedUserEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

ReposListInvitationsForAuthenticatedUserRequestOptions

ReposListInvitationsForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/repository_invitations" }

Type declaration

ReposListInvitationsForAuthenticatedUserResponseData

ReposListInvitationsForAuthenticatedUserResponseData: { created_at: string; html_url: string; id: number; invitee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; inviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: string; repository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }; url: string }[]

ReposListInvitationsRequestOptions

ReposListInvitationsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/invitations" }

Type declaration

ReposListInvitationsResponseData

ReposListInvitationsResponseData: { created_at: string; html_url: string; id: number; invitee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; inviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: string; repository: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }; url: string }[]

ReposListLanguagesEndpoint

ReposListLanguagesEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposListLanguagesRequestOptions

ReposListLanguagesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/languages" }

Type declaration

ReposListPagesBuildsEndpoint

ReposListPagesBuildsEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListPagesBuildsRequestOptions

ReposListPagesBuildsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages/builds" }

Type declaration

ReposListPagesBuildsResponseData

ReposListPagesBuildsResponseData: { commit: string; created_at: string; duration: number; error: { message: string }; pusher: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; status: string; updated_at: string; url: string }[]

ReposListPublicEndpoint

ReposListPublicEndpoint: { since?: undefined | number }

Type declaration

  • Optional since?: undefined | number

    The integer ID of the last repository that you've seen.

ReposListPublicRequestOptions

ReposListPublicRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repositories" }

Type declaration

ReposListPublicResponseData

ReposListPublicResponseData: { archive_url: string; assignees_url: string; blobs_url: string; branches_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; deployments_url: string; description: string; downloads_url: string; events_url: string; fork: boolean; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; html_url: string; id: number; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; languages_url: string; merges_url: string; milestones_url: string; name: string; node_id: string; notifications_url: string; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; private: boolean; pulls_url: string; releases_url: string; ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; subscription_url: string; tags_url: string; teams_url: string; trees_url: string; url: string }[]

ReposListPullRequestsAssociatedWithCommitEndpoint

ReposListPullRequestsAssociatedWithCommitEndpoint: { commit_sha: string; owner: string; page?: undefined | number; per_page?: undefined | number; repo: string } & RequiredPreview<"groot">

ReposListPullRequestsAssociatedWithCommitRequestOptions

ReposListPullRequestsAssociatedWithCommitRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/commits/:commit_sha/pulls" }

Type declaration

ReposListPullRequestsAssociatedWithCommitResponseData

ReposListPullRequestsAssociatedWithCommitResponseData: { _links: { comments: { href: string }; commits: { href: string }; html: { href: string }; issue: { href: string }; review_comment: { href: string }; review_comments: { href: string }; self: { href: string }; statuses: { href: string } }; active_lock_reason: string; assignee: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; assignees: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]; author_association: string; base: { label: string; ref: string; repo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }; sha: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }; body: string; closed_at: string; comments_url: string; commits_url: string; created_at: string; diff_url: string; draft: boolean; head: { label: string; ref: string; repo: { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }; sha: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }; html_url: string; id: number; issue_url: string; labels: { color: string; default: boolean; description: string; id: number; name: string; node_id: string; url: string }[]; locked: boolean; merge_commit_sha: string; merged_at: string; milestone: { closed_at: string; closed_issues: number; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; description: string; due_on: string; html_url: string; id: number; labels_url: string; node_id: string; number: number; open_issues: number; state: string; title: string; updated_at: string; url: string }; node_id: string; number: number; patch_url: string; requested_reviewers: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]; requested_teams: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: {}; permission: string; privacy: string; repositories_url: string; slug: string; url: string }[]; review_comment_url: string; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; user: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string } }[]

ReposListReleaseAssetsEndpoint

ReposListReleaseAssetsEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; release_id: number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • release_id: number
  • repo: string

ReposListReleaseAssetsRequestOptions

ReposListReleaseAssetsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/:release_id/assets" }

Type declaration

ReposListReleaseAssetsResponseData

ReposListReleaseAssetsResponseData: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; url: string }[]

ReposListReleasesEndpoint

ReposListReleasesEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListReleasesRequestOptions

ReposListReleasesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases" }

Type declaration

ReposListReleasesResponseData

ReposListReleasesResponseData: { assets: { browser_download_url: string; content_type: string; created_at: string; download_count: number; id: number; label: string; name: string; node_id: string; size: number; state: string; updated_at: string; uploader: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; url: string }[]; assets_url: string; author: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; body: string; created_at: string; draft: boolean; html_url: string; id: number; name: string; node_id: string; prerelease: boolean; published_at: string; tag_name: string; tarball_url: string; target_commitish: string; upload_url: string; url: string; zipball_url: string }[]

ReposListTagsEndpoint

ReposListTagsEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListTagsRequestOptions

ReposListTagsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/tags" }

Type declaration

ReposListTagsResponseData

ReposListTagsResponseData: { commit: { sha: string; url: string }; name: string; tarball_url: string; zipball_url: string }[]

ReposListTeamsEndpoint

ReposListTeamsEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListTeamsRequestOptions

ReposListTeamsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/teams" }

Type declaration

ReposListTeamsResponseData

ReposListTeamsResponseData: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: {}; permission: string; privacy: string; repositories_url: string; slug: string; url: string }[]

ReposListWebhooksEndpoint

ReposListWebhooksEndpoint: { owner: string; page?: undefined | number; per_page?: undefined | number; repo: string }

Type declaration

  • owner: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • repo: string

ReposListWebhooksRequestOptions

ReposListWebhooksRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks" }

Type declaration

ReposListWebhooksResponseData

ReposListWebhooksResponseData: { active: boolean; config: { content_type: string; insecure_ssl: string; url: string }; created_at: string; events: string[]; id: number; last_response: { code: string; message: string; status: string }; name: string; ping_url: string; test_url: string; type: string; updated_at: string; url: string }[]

ReposMergeEndpoint

ReposMergeEndpoint: { base: string; commit_message?: undefined | string; head: string; owner: string; repo: string }

Type declaration

  • base: string

    The name of the base branch that the head will be merged into.

  • Optional commit_message?: undefined | string

    Commit message to use for the merge commit. If omitted, a default message will be used.

  • head: string

    The head to merge. This can be a branch name or a commit SHA1.

  • owner: string
  • repo: string

ReposMergeRequestOptions

ReposMergeRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/merges" }

Type declaration

ReposPingWebhookEndpoint

ReposPingWebhookEndpoint: { hook_id: number; owner: string; repo: string }

Type declaration

  • hook_id: number
  • owner: string
  • repo: string

ReposPingWebhookRequestOptions

ReposPingWebhookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks/:hook_id/pings" }

Type declaration

ReposRemoveAppAccessRestrictionsEndpoint

ReposRemoveAppAccessRestrictionsEndpoint: { apps: string[]; branch: string; owner: string; repo: string }

Type declaration

  • apps: string[]

    apps parameter

  • branch: string
  • owner: string
  • repo: string

ReposRemoveAppAccessRestrictionsRequestOptions

ReposRemoveAppAccessRestrictionsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" }

Type declaration

ReposRemoveAppAccessRestrictionsResponseData

ReposRemoveAppAccessRestrictionsResponseData: { created_at: string; description: string; events: string[]; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }; permissions: { contents: string; issues: string; metadata: string; single_file: string }; slug: string; updated_at: string }[]

ReposRemoveCollaboratorEndpoint

ReposRemoveCollaboratorEndpoint: { owner: string; repo: string; username: string }

Type declaration

  • owner: string
  • repo: string
  • username: string

ReposRemoveCollaboratorRequestOptions

ReposRemoveCollaboratorRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/collaborators/:username" }

Type declaration

ReposRemoveStatusCheckContextsEndpoint

ReposRemoveStatusCheckContextsEndpoint: { branch: string; contexts: string[]; owner: string; repo: string }

Type declaration

  • branch: string
  • contexts: string[]

    contexts parameter

  • owner: string
  • repo: string

ReposRemoveStatusCheckContextsRequestOptions

ReposRemoveStatusCheckContextsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" }

Type declaration

ReposRemoveStatusCheckContextsResponseData

ReposRemoveStatusCheckContextsResponseData: string[]

ReposRemoveStatusCheckProtectionEndpoint

ReposRemoveStatusCheckProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposRemoveStatusCheckProtectionRequestOptions

ReposRemoveStatusCheckProtectionRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" }

Type declaration

ReposRemoveTeamAccessRestrictionsEndpoint

ReposRemoveTeamAccessRestrictionsEndpoint: { branch: string; owner: string; repo: string; teams: string[] }

Type declaration

  • branch: string
  • owner: string
  • repo: string
  • teams: string[]

    teams parameter

ReposRemoveTeamAccessRestrictionsRequestOptions

ReposRemoveTeamAccessRestrictionsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" }

Type declaration

ReposRemoveTeamAccessRestrictionsResponseData

ReposRemoveTeamAccessRestrictionsResponseData: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: {}; permission: string; privacy: string; repositories_url: string; slug: string; url: string }[]

ReposRemoveUserAccessRestrictionsEndpoint

ReposRemoveUserAccessRestrictionsEndpoint: { branch: string; owner: string; repo: string; users: string[] }

Type declaration

  • branch: string
  • owner: string
  • repo: string
  • users: string[]

    users parameter

ReposRemoveUserAccessRestrictionsRequestOptions

ReposRemoveUserAccessRestrictionsRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" }

Type declaration

ReposRemoveUserAccessRestrictionsResponseData

ReposRemoveUserAccessRestrictionsResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

ReposReplaceAllTopicsEndpoint

ReposReplaceAllTopicsEndpoint: { names: string[]; owner: string; repo: string } & RequiredPreview<"mercy">

ReposReplaceAllTopicsRequestOptions

ReposReplaceAllTopicsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/topics" }

Type declaration

ReposRequestPagesBuildEndpoint

ReposRequestPagesBuildEndpoint: { owner: string; repo: string }

Type declaration

  • owner: string
  • repo: string

ReposRequestPagesBuildRequestOptions

ReposRequestPagesBuildRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages/builds" }

Type declaration

ReposSetAdminBranchProtectionEndpoint

ReposSetAdminBranchProtectionEndpoint: { branch: string; owner: string; repo: string }

Type declaration

  • branch: string
  • owner: string
  • repo: string

ReposSetAdminBranchProtectionRequestOptions

ReposSetAdminBranchProtectionRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" }

Type declaration

ReposSetAppAccessRestrictionsEndpoint

ReposSetAppAccessRestrictionsEndpoint: { apps: string[]; branch: string; owner: string; repo: string }

Type declaration

  • apps: string[]

    apps parameter

  • branch: string
  • owner: string
  • repo: string

ReposSetAppAccessRestrictionsRequestOptions

ReposSetAppAccessRestrictionsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" }

Type declaration

ReposSetAppAccessRestrictionsResponseData

ReposSetAppAccessRestrictionsResponseData: { created_at: string; description: string; events: string[]; external_url: string; html_url: string; id: number; name: string; node_id: string; owner: { avatar_url: string; description: string; events_url: string; hooks_url: string; id: number; issues_url: string; login: string; members_url: string; node_id: string; public_members_url: string; repos_url: string; url: string }; permissions: { contents: string; issues: string; metadata: string; single_file: string }; slug: string; updated_at: string }[]

ReposSetStatusCheckContextsEndpoint

ReposSetStatusCheckContextsEndpoint: { branch: string; contexts: string[]; owner: string; repo: string }

Type declaration

  • branch: string
  • contexts: string[]

    contexts parameter

  • owner: string
  • repo: string

ReposSetStatusCheckContextsRequestOptions

ReposSetStatusCheckContextsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" }

Type declaration

ReposSetStatusCheckContextsResponseData

ReposSetStatusCheckContextsResponseData: string[]

ReposSetTeamAccessRestrictionsEndpoint

ReposSetTeamAccessRestrictionsEndpoint: { branch: string; owner: string; repo: string; teams: string[] }

Type declaration

  • branch: string
  • owner: string
  • repo: string
  • teams: string[]

    teams parameter

ReposSetTeamAccessRestrictionsRequestOptions

ReposSetTeamAccessRestrictionsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" }

Type declaration

ReposSetTeamAccessRestrictionsResponseData

ReposSetTeamAccessRestrictionsResponseData: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: {}; permission: string; privacy: string; repositories_url: string; slug: string; url: string }[]

ReposSetUserAccessRestrictionsEndpoint

ReposSetUserAccessRestrictionsEndpoint: { branch: string; owner: string; repo: string; users: string[] }

Type declaration

  • branch: string
  • owner: string
  • repo: string
  • users: string[]

    users parameter

ReposSetUserAccessRestrictionsRequestOptions

ReposSetUserAccessRestrictionsRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" }

Type declaration

ReposSetUserAccessRestrictionsResponseData

ReposSetUserAccessRestrictionsResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

ReposTestPushWebhookEndpoint

ReposTestPushWebhookEndpoint: { hook_id: number; owner: string; repo: string }

Type declaration

  • hook_id: number
  • owner: string
  • repo: string

ReposTestPushWebhookRequestOptions

ReposTestPushWebhookRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks/:hook_id/tests" }

Type declaration

ReposTransferEndpoint

ReposTransferEndpoint: { new_owner?: undefined | string; owner: string; repo: string; team_ids?: number[] }

Type declaration

  • Optional new_owner?: undefined | string

    Required: The username or organization name the repository will be transferred to.

  • owner: string
  • repo: string
  • Optional team_ids?: number[]

    ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

ReposTransferRequestOptions

ReposTransferRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/transfer" }

Type declaration

ReposUpdateBranchProtectionEndpoint

ReposUpdateBranchProtectionEndpoint: { allow_deletions?: undefined | false | true; allow_force_pushes?: boolean | null; branch: string; enforce_admins: boolean | null; owner: string; repo: string; required_linear_history?: undefined | false | true; required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null; required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null; restrictions: ReposUpdateBranchProtectionParamsRestrictions | null }

Type declaration

  • Optional allow_deletions?: undefined | false | true

    Allows deletion of the protected branch by anyone with write access to the repository. Set to false to prevent deletion of the protected branch. Default: false. For more information, see "Enabling force pushes to a protected branch".

  • Optional allow_force_pushes?: boolean | null

    Permits force pushes to the protected branch by anyone with write access to the repository. Set to true to allow force pushes. Set to false or null to block force pushes. Default: false. For more information, see "Enabling force pushes to a protected branch".

  • branch: string
  • enforce_admins: boolean | null

    Enforce all configured restrictions for administrators. Set to true to enforce required status checks for repository administrators. Set to null to disable.

  • owner: string
  • repo: string
  • Optional required_linear_history?: undefined | false | true

    Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to true to enforce a linear commit history. Set to false to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: false. For more information, see "Requiring a linear commit history".

  • required_pull_request_reviews: ReposUpdateBranchProtectionParamsRequiredPullRequestReviews | null

    Require at least one approving review on a pull request, before merging. Set to null to disable.

  • required_status_checks: ReposUpdateBranchProtectionParamsRequiredStatusChecks | null

    Require status checks to pass before merging. Set to null to disable.

  • restrictions: ReposUpdateBranchProtectionParamsRestrictions | null

    Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories. Set to null to disable.

ReposUpdateBranchProtectionParamsRequiredPullRequestReviews

ReposUpdateBranchProtectionParamsRequiredPullRequestReviews: { dismiss_stale_reviews?: undefined | false | true; dismissal_restrictions?: ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions; require_code_owner_reviews?: undefined | false | true; required_approving_review_count?: undefined | number }

Type declaration

ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions

ReposUpdateBranchProtectionParamsRequiredPullRequestReviewsDismissalRestrictions: { teams?: string[]; users?: string[] }

Type declaration

  • Optional teams?: string[]
  • Optional users?: string[]

ReposUpdateBranchProtectionParamsRequiredStatusChecks

ReposUpdateBranchProtectionParamsRequiredStatusChecks: { contexts: string[]; strict: boolean }

Type declaration

  • contexts: string[]
  • strict: boolean

ReposUpdateBranchProtectionParamsRestrictions

ReposUpdateBranchProtectionParamsRestrictions: { apps?: string[]; teams: string[]; users: string[] }

Type declaration

  • Optional apps?: string[]
  • teams: string[]
  • users: string[]

ReposUpdateBranchProtectionRequestOptions

ReposUpdateBranchProtectionRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection" }

Type declaration

ReposUpdateCommitCommentEndpoint

ReposUpdateCommitCommentEndpoint: { body: string; comment_id: number; owner: string; repo: string }

Type declaration

  • body: string

    The contents of the comment

  • comment_id: number
  • owner: string
  • repo: string

ReposUpdateCommitCommentRequestOptions

ReposUpdateCommitCommentRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/comments/:comment_id" }

Type declaration

ReposUpdateEndpoint

ReposUpdateEndpoint: { allow_merge_commit?: undefined | false | true; allow_rebase_merge?: undefined | false | true; allow_squash_merge?: undefined | false | true; archived?: undefined | false | true; default_branch?: undefined | string; delete_branch_on_merge?: undefined | false | true; description?: undefined | string; has_issues?: undefined | false | true; has_projects?: undefined | false | true; has_wiki?: undefined | false | true; homepage?: undefined | string; is_template?: undefined | false | true; name?: undefined | string; owner: string; private?: undefined | false | true; repo: string; visibility?: "public" | "private" | "visibility" | "internal" }

Type declaration

  • Optional allow_merge_commit?: undefined | false | true

    Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

  • Optional allow_rebase_merge?: undefined | false | true

    Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

  • Optional allow_squash_merge?: undefined | false | true

    Either true to allow squash-merging pull requests, or false to prevent squash-merging.

  • Optional archived?: undefined | false | true

    true to archive this repository. Note: You cannot unarchive repositories through the API.

  • Optional default_branch?: undefined | string

    Updates the default branch for this repository.

  • Optional delete_branch_on_merge?: undefined | false | true

    Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

  • Optional description?: undefined | string

    A short description of the repository.

  • Optional has_issues?: undefined | false | true

    Either true to enable issues for this repository or false to disable them.

  • Optional has_projects?: undefined | false | true

    Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

  • Optional has_wiki?: undefined | false | true

    Either true to enable the wiki for this repository or false to disable it.

  • Optional homepage?: undefined | string

    A URL with more information about the repository.

  • Optional is_template?: undefined | false | true

    Either true to make this repo available as a template repository or false to prevent it.

  • Optional name?: undefined | string

    The name of the repository.

  • owner: string
  • Optional private?: undefined | false | true

    Either true to make the repository private or false to make it public. Default: false. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

  • repo: string
  • Optional visibility?: "public" | "private" | "visibility" | "internal"

    Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. The visibility parameter overrides the private parameter when you use both along with the nebula-preview preview header.

ReposUpdateInformationAboutPagesSiteEndpoint

ReposUpdateInformationAboutPagesSiteEndpoint: { cname?: undefined | string; owner: string; repo: string; source?: "gh-pages" | "master" | "master /docs" }

Type declaration

  • Optional cname?: undefined | string

    Specify a custom domain for the repository. Sending a null value will remove the custom domain. For more about custom domains, see "Using a custom domain with GitHub Pages."

  • owner: string
  • repo: string
  • Optional source?: "gh-pages" | "master" | "master /docs"

    Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory /docs. Possible values are "gh-pages", "master", and "master /docs".

ReposUpdateInformationAboutPagesSiteRequestOptions

ReposUpdateInformationAboutPagesSiteRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/repos/:owner/:repo/pages" }

Type declaration

ReposUpdateInvitationEndpoint

ReposUpdateInvitationEndpoint: { invitation_id: number; owner: string; permissions?: "read" | "write" | "maintain" | "triage" | "admin"; repo: string }

Type declaration

  • invitation_id: number
  • owner: string
  • Optional permissions?: "read" | "write" | "maintain" | "triage" | "admin"

    The permissions that the associated user will have on the repository. Valid values are read, write, maintain, triage, and admin.

  • repo: string

ReposUpdateInvitationRequestOptions

ReposUpdateInvitationRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/invitations/:invitation_id" }

Type declaration

ReposUpdatePullRequestReviewProtectionEndpoint

ReposUpdatePullRequestReviewProtectionEndpoint: { branch: string; dismiss_stale_reviews?: undefined | false | true; dismissal_restrictions?: ReposUpdatePullRequestReviewProtectionParamsDismissalRestrictions; owner: string; repo: string; require_code_owner_reviews?: undefined | false | true; required_approving_review_count?: undefined | number }

Type declaration

  • branch: string
  • Optional dismiss_stale_reviews?: undefined | false | true

    Set to true if you want to automatically dismiss approving reviews when someone pushes a new commit.

  • Optional dismissal_restrictions?: ReposUpdatePullRequestReviewProtectionParamsDismissalRestrictions

    Specify which users and teams can dismiss pull request reviews. Pass an empty dismissal_restrictions object to disable. User and team dismissal_restrictions are only available for organization-owned repositories. Omit this parameter for personal repositories.

  • owner: string
  • repo: string
  • Optional require_code_owner_reviews?: undefined | false | true

    Blocks merging pull requests until code owners have reviewed.

  • Optional required_approving_review_count?: undefined | number

    Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.

ReposUpdatePullRequestReviewProtectionParamsDismissalRestrictions

ReposUpdatePullRequestReviewProtectionParamsDismissalRestrictions: { teams?: string[]; users?: string[] }

Type declaration

  • Optional teams?: string[]
  • Optional users?: string[]

ReposUpdatePullRequestReviewProtectionRequestOptions

ReposUpdatePullRequestReviewProtectionRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" }

Type declaration

ReposUpdateReleaseAssetEndpoint

ReposUpdateReleaseAssetEndpoint: { asset_id: number; label?: undefined | string; name?: undefined | string; owner: string; repo: string }

Type declaration

  • asset_id: number
  • Optional label?: undefined | string

    An alternate short description of the asset. Used in place of the filename.

  • Optional name?: undefined | string

    The file name of the asset.

  • owner: string
  • repo: string

ReposUpdateReleaseAssetRequestOptions

ReposUpdateReleaseAssetRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/assets/:asset_id" }

Type declaration

ReposUpdateReleaseEndpoint

ReposUpdateReleaseEndpoint: { body?: undefined | string; draft?: undefined | false | true; name?: undefined | string; owner: string; prerelease?: undefined | false | true; release_id: number; repo: string; tag_name?: undefined | string; target_commitish?: undefined | string }

Type declaration

  • Optional body?: undefined | string

    Text describing the contents of the tag.

  • Optional draft?: undefined | false | true

    true makes the release a draft, and false publishes the release.

  • Optional name?: undefined | string

    The name of the release.

  • owner: string
  • Optional prerelease?: undefined | false | true

    true to identify the release as a prerelease, false to identify the release as a full release.

  • release_id: number
  • repo: string
  • Optional tag_name?: undefined | string

    The name of the tag.

  • Optional target_commitish?: undefined | string

    Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually master).

ReposUpdateReleaseRequestOptions

ReposUpdateReleaseRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/:release_id" }

Type declaration

ReposUpdateRequestOptions

ReposUpdateRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo" }

Type declaration

ReposUpdateStatusCheckPotectionEndpoint

ReposUpdateStatusCheckPotectionEndpoint: { branch: string; contexts?: string[]; owner: string; repo: string; strict?: undefined | false | true }

Type declaration

  • branch: string
  • Optional contexts?: string[]

    The list of status checks to require in order to merge into this branch

  • owner: string
  • repo: string
  • Optional strict?: undefined | false | true

    Require branches to be up to date before merging.

ReposUpdateStatusCheckPotectionRequestOptions

ReposUpdateStatusCheckPotectionRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" }

Type declaration

ReposUpdateWebhookEndpoint

ReposUpdateWebhookEndpoint: { active?: undefined | false | true; add_events?: string[]; config?: ReposUpdateWebhookParamsConfig; events?: string[]; hook_id: number; owner: string; remove_events?: string[]; repo: string }

Type declaration

  • Optional active?: undefined | false | true

    Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

  • Optional add_events?: string[]

    Determines a list of events to be added to the list of events that the Hook triggers for.

  • Optional config?: ReposUpdateWebhookParamsConfig

    Key/value pairs to provide settings for this webhook. These are defined below.

  • Optional events?: string[]

    Determines what events the hook is triggered for. This replaces the entire array of events.

  • hook_id: number
  • owner: string
  • Optional remove_events?: string[]

    Determines a list of events to be removed from the list of events that the Hook triggers for.

  • repo: string

ReposUpdateWebhookParamsConfig

ReposUpdateWebhookParamsConfig: { content_type?: undefined | string; insecure_ssl?: undefined | string; secret?: undefined | string; url: string }

Type declaration

  • Optional content_type?: undefined | string
  • Optional insecure_ssl?: undefined | string
  • Optional secret?: undefined | string
  • url: string

ReposUpdateWebhookRequestOptions

ReposUpdateWebhookRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/repos/:owner/:repo/hooks/:hook_id" }

Type declaration

ReposUploadReleaseAssetEndpoint

ReposUploadReleaseAssetEndpoint: { baseUrl: string; data: string | Buffer; label?: undefined | string; name?: undefined | string; origin?: undefined | string; owner: string; release_id: number; repo: string } & { headers: { content-type: string } }

ReposUploadReleaseAssetRequestOptions

ReposUploadReleaseAssetRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/repos/:owner/:repo/releases/:release_id/assets{?name,label}" }

Type declaration

RequiredPreview

RequiredPreview<T>: { mediaType: { previews: [T, string] } }

Type parameters

  • T

Type declaration

  • mediaType: { previews: [T, string] }
    • previews: [T, string]

ScimDeleteUserFromOrgEndpoint

ScimDeleteUserFromOrgEndpoint: { org: string; scim_user_id: string }

Type declaration

  • org: string
  • scim_user_id: string

    Identifier generated by the GitHub SCIM endpoint.

ScimDeleteUserFromOrgRequestOptions

ScimDeleteUserFromOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/scim/v2/organizations/:org/Users/:scim_user_id" }

Type declaration

ScimGetProvisioningInformationForUserEndpoint

ScimGetProvisioningInformationForUserEndpoint: { org: string; scim_user_id: string }

Type declaration

  • org: string
  • scim_user_id: string

    Identifier generated by the GitHub SCIM endpoint.

ScimGetProvisioningInformationForUserRequestOptions

ScimGetProvisioningInformationForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/scim/v2/organizations/:org/Users/:scim_user_id" }

Type declaration

ScimListProvisionedIdentitiesEndpoint

ScimListProvisionedIdentitiesEndpoint: { count?: undefined | number; filter?: undefined | string; org: string; startIndex?: undefined | number }

Type declaration

  • Optional count?: undefined | number

    Used for pagination: the number of results to return.

  • Optional filter?: undefined | string

    Filters results using the equals query parameter operator (eq). You can filter results that are equal to id, userName, emails, and external_id. For example, to search for an identity with the userName Octocat, you would use this query:

    ?filter=userName%20eq%20\"Octocat\".

    To filter results for for the identity with the email octocat@github.com, you would use this query:

    ?filter=emails%20eq%20\"octocat@github.com\".

  • org: string
  • Optional startIndex?: undefined | number

    Used for pagination: the index of the first result to return.

ScimListProvisionedIdentitiesRequestOptions

ScimListProvisionedIdentitiesRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/scim/v2/organizations/:org/Users" }

Type declaration

ScimProvisionAndInviteUserEndpoint

ScimProvisionAndInviteUserEndpoint: { emails: ScimProvisionAndInviteUserParamsEmails[]; name: ScimProvisionAndInviteUserParamsName; org: string; schemas: string[]; userName: string }

Type declaration

ScimProvisionAndInviteUserParamsEmails

ScimProvisionAndInviteUserParamsEmails: { primary: boolean; type: string; value: string }

Type declaration

  • primary: boolean
  • type: string
  • value: string

ScimProvisionAndInviteUserParamsName

ScimProvisionAndInviteUserParamsName: { familyName: string; givenName: string }

Type declaration

  • familyName: string
  • givenName: string

ScimProvisionAndInviteUserRequestOptions

ScimProvisionAndInviteUserRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/scim/v2/organizations/:org/Users" }

Type declaration

ScimSetInformationForProvisionedUserEndpoint

ScimSetInformationForProvisionedUserEndpoint: { emails: ScimSetInformationForProvisionedUserParamsEmails[]; name: ScimSetInformationForProvisionedUserParamsName; org: string; schemas: string[]; scim_user_id: string; userName: string }

Type declaration

ScimSetInformationForProvisionedUserParamsEmails

ScimSetInformationForProvisionedUserParamsEmails: { primary: boolean; type: string; value: string }

Type declaration

  • primary: boolean
  • type: string
  • value: string

ScimSetInformationForProvisionedUserParamsName

ScimSetInformationForProvisionedUserParamsName: { familyName: string; givenName: string }

Type declaration

  • familyName: string
  • givenName: string

ScimSetInformationForProvisionedUserRequestOptions

ScimSetInformationForProvisionedUserRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/scim/v2/organizations/:org/Users/:scim_user_id" }

Type declaration

ScimUpdateAttributeForUserEndpoint

ScimUpdateAttributeForUserEndpoint: { Operations: ScimUpdateAttributeForUserParamsOperations[]; org: string; schemas: string[]; scim_user_id: string }

Type declaration

ScimUpdateAttributeForUserParamsOperations

ScimUpdateAttributeForUserParamsOperations: {}

Type declaration

ScimUpdateAttributeForUserRequestOptions

ScimUpdateAttributeForUserRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/scim/v2/organizations/:org/Users/:scim_user_id" }

Type declaration

SearchCodeEndpoint

SearchCodeEndpoint: { order?: "desc" | "asc"; page?: undefined | number; per_page?: undefined | number; q: string; sort?: undefined | "indexed" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching code" for a detailed list of qualifiers.

  • Optional sort?: undefined | "indexed"

    Sorts the results of your query. Can only be indexed, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: best match

SearchCodeRequestOptions

SearchCodeRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/code" }

Type declaration

SearchCommitsEndpoint

SearchCommitsEndpoint: { order?: "desc" | "asc"; page?: undefined | number; per_page?: undefined | number; q: string; sort?: "author-date" | "committer-date" } & RequiredPreview<"cloak">

SearchCommitsRequestOptions

SearchCommitsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/commits" }

Type declaration

SearchIssuesAndPullRequestsEndpoint

SearchIssuesAndPullRequestsEndpoint: { order?: "desc" | "asc"; page?: undefined | number; per_page?: undefined | number; q: string; sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching issues and pull requests" for a detailed list of qualifiers.

  • Optional sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"

    Sorts the results of your query by the number of comments, reactions, reactions-+1, reactions--1, reactions-smile, reactions-thinking_face, reactions-heart, reactions-tada, or interactions. You can also sort results by how recently the items were created or updated, Default: best match

SearchIssuesAndPullRequestsRequestOptions

SearchIssuesAndPullRequestsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/issues" }

Type declaration

SearchLabelsEndpoint

SearchLabelsEndpoint: { order?: "desc" | "asc"; q: string; repository_id: number; sort?: "created" | "updated" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • q: string

    The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see Constructing a search query.

  • repository_id: number

    The id of the repository.

  • Optional sort?: "created" | "updated"

    Sorts the results of your query by when the label was created or updated. Default: best match

SearchLabelsRequestOptions

SearchLabelsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/labels" }

Type declaration

SearchReposEndpoint

SearchReposEndpoint: { order?: "desc" | "asc"; page?: undefined | number; per_page?: undefined | number; q: string; sort?: "stars" | "forks" | "help-wanted-issues" | "updated" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching for repositories" for a detailed list of qualifiers.

  • Optional sort?: "stars" | "forks" | "help-wanted-issues" | "updated"

    Sorts the results of your query by number of stars, forks, or help-wanted-issues or how recently the items were updated. Default: best match

SearchReposRequestOptions

SearchReposRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/repositories" }

Type declaration

SearchTopicsEndpoint

SearchTopicsEndpoint: { q: string } & RequiredPreview<"mercy">

SearchTopicsRequestOptions

SearchTopicsRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/topics" }

Type declaration

SearchUsersEndpoint

SearchUsersEndpoint: { order?: "desc" | "asc"; page?: undefined | number; per_page?: undefined | number; q: string; sort?: "followers" | "repositories" | "joined" }

Type declaration

  • Optional order?: "desc" | "asc"

    Determines whether the first search result returned is the highest number of matches (desc) or lowest number of matches (asc). This parameter is ignored unless you provide sort.

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • q: string

    The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see Constructing a search query. See "Searching users" for a detailed list of qualifiers.

  • Optional sort?: "followers" | "repositories" | "joined"

    Sorts the results of your query by number of followers or repositories, or when the person joined GitHub. Default: best match

SearchUsersRequestOptions

SearchUsersRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/search/users" }

Type declaration

TeamsAddMemberLegacyEndpoint

TeamsAddMemberLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number
  • username: string

TeamsAddMemberLegacyRequestOptions

TeamsAddMemberLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/teams/:team_id/members/:username" }

Type declaration

TeamsAddOrUpdateMembershipForUserInOrgEndpoint

TeamsAddOrUpdateMembershipForUserInOrgEndpoint: { org: string; role?: "member" | "maintainer"; team_slug: string; username: string }

Type declaration

  • org: string
  • Optional role?: "member" | "maintainer"

    The role that this user should have in the team. Can be one of: * member - a normal member of the team. * maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

  • team_slug: string
  • username: string

TeamsAddOrUpdateMembershipForUserInOrgRequestOptions

TeamsAddOrUpdateMembershipForUserInOrgRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/memberships/:username" }

Type declaration

TeamsAddOrUpdateMembershipForUserLegacyEndpoint

TeamsAddOrUpdateMembershipForUserLegacyEndpoint: { role?: "member" | "maintainer"; team_id: number; username: string }

Type declaration

  • Optional role?: "member" | "maintainer"

    The role that this user should have in the team. Can be one of: * member - a normal member of the team. * maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

  • team_id: number
  • username: string

TeamsAddOrUpdateMembershipForUserLegacyRequestOptions

TeamsAddOrUpdateMembershipForUserLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/teams/:team_id/memberships/:username" }

Type declaration

TeamsAddOrUpdateProjectPermissionsInOrgEndpoint

TeamsAddOrUpdateProjectPermissionsInOrgEndpoint: { org: string; permission?: "read" | "write" | "admin"; project_id: number; team_slug: string } & RequiredPreview<"inertia">

TeamsAddOrUpdateProjectPermissionsInOrgRequestOptions

TeamsAddOrUpdateProjectPermissionsInOrgRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/projects/:project_id" }

Type declaration

TeamsAddOrUpdateProjectPermissionsLegacyEndpoint

TeamsAddOrUpdateProjectPermissionsLegacyEndpoint: { permission?: "read" | "write" | "admin"; project_id: number; team_id: number } & RequiredPreview<"inertia">

TeamsAddOrUpdateProjectPermissionsLegacyRequestOptions

TeamsAddOrUpdateProjectPermissionsLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/teams/:team_id/projects/:project_id" }

Type declaration

TeamsAddOrUpdateRepoPermissionsInOrgEndpoint

TeamsAddOrUpdateRepoPermissionsInOrgEndpoint: { org: string; owner: string; permission?: "pull" | "push" | "admin" | "maintain" | "triage"; repo: string; team_slug: string }

Type declaration

  • org: string
  • owner: string
  • Optional permission?: "pull" | "push" | "admin" | "maintain" | "triage"

    The permission to grant the team on this repository. Can be one of: * pull - team members can pull, but not push to or administer this repository. * push - team members can pull and push, but not administer this repository. * admin - team members can pull, push and administer this repository. * maintain - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. * triage - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations.

    If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

  • repo: string
  • team_slug: string

TeamsAddOrUpdateRepoPermissionsInOrgRequestOptions

TeamsAddOrUpdateRepoPermissionsInOrgRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo" }

Type declaration

TeamsAddOrUpdateRepoPermissionsLegacyEndpoint

TeamsAddOrUpdateRepoPermissionsLegacyEndpoint: { owner: string; permission?: "pull" | "push" | "admin"; repo: string; team_id: number }

Type declaration

  • owner: string
  • Optional permission?: "pull" | "push" | "admin"

    The permission to grant the team on this repository. Can be one of: * pull - team members can pull, but not push to or administer this repository. * push - team members can pull and push, but not administer this repository. * admin - team members can pull, push and administer this repository.

    If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

  • repo: string
  • team_id: number

TeamsAddOrUpdateRepoPermissionsLegacyRequestOptions

TeamsAddOrUpdateRepoPermissionsLegacyRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/teams/:team_id/repos/:owner/:repo" }

Type declaration

TeamsCheckPermissionsForProjectInOrgEndpoint

TeamsCheckPermissionsForProjectInOrgEndpoint: { org: string; project_id: number; team_slug: string } & RequiredPreview<"inertia">

TeamsCheckPermissionsForProjectInOrgRequestOptions

TeamsCheckPermissionsForProjectInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/projects/:project_id" }

Type declaration

TeamsCheckPermissionsForProjectLegacyEndpoint

TeamsCheckPermissionsForProjectLegacyEndpoint: { project_id: number; team_id: number } & RequiredPreview<"inertia">

TeamsCheckPermissionsForProjectLegacyRequestOptions

TeamsCheckPermissionsForProjectLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/projects/:project_id" }

Type declaration

TeamsCheckPermissionsForRepoInOrgEndpoint

TeamsCheckPermissionsForRepoInOrgEndpoint: { org: string; owner: string; repo: string; team_slug: string }

Type declaration

  • org: string
  • owner: string
  • repo: string
  • team_slug: string

TeamsCheckPermissionsForRepoInOrgRequestOptions

TeamsCheckPermissionsForRepoInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo" }

Type declaration

TeamsCheckPermissionsForRepoLegacyEndpoint

TeamsCheckPermissionsForRepoLegacyEndpoint: { owner: string; repo: string; team_id: number }

Type declaration

  • owner: string
  • repo: string
  • team_id: number

TeamsCheckPermissionsForRepoLegacyRequestOptions

TeamsCheckPermissionsForRepoLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/repos/:owner/:repo" }

Type declaration

TeamsCreateDiscussionCommentInOrgEndpoint

TeamsCreateDiscussionCommentInOrgEndpoint: { body: string; discussion_number: number; org: string; team_slug: string }

Type declaration

  • body: string

    The discussion comment's body text.

  • discussion_number: number
  • org: string
  • team_slug: string

TeamsCreateDiscussionCommentInOrgRequestOptions

TeamsCreateDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments" }

Type declaration

TeamsCreateDiscussionCommentLegacyEndpoint

TeamsCreateDiscussionCommentLegacyEndpoint: { body: string; discussion_number: number; team_id: number }

Type declaration

  • body: string

    The discussion comment's body text.

  • discussion_number: number
  • team_id: number

TeamsCreateDiscussionCommentLegacyRequestOptions

TeamsCreateDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments" }

Type declaration

TeamsCreateDiscussionInOrgEndpoint

TeamsCreateDiscussionInOrgEndpoint: { body: string; org: string; private?: undefined | false | true; team_slug: string; title: string }

Type declaration

  • body: string

    The discussion post's body text.

  • org: string
  • Optional private?: undefined | false | true

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

  • team_slug: string
  • title: string

    The discussion post's title.

TeamsCreateDiscussionInOrgRequestOptions

TeamsCreateDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions" }

Type declaration

TeamsCreateDiscussionLegacyEndpoint

TeamsCreateDiscussionLegacyEndpoint: { body: string; private?: undefined | false | true; team_id: number; title: string }

Type declaration

  • body: string

    The discussion post's body text.

  • Optional private?: undefined | false | true

    Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

  • team_id: number
  • title: string

    The discussion post's title.

TeamsCreateDiscussionLegacyRequestOptions

TeamsCreateDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/teams/:team_id/discussions" }

Type declaration

TeamsCreateEndpoint

TeamsCreateEndpoint: { description?: undefined | string; maintainers?: string[]; name: string; org: string; parent_team_id?: undefined | number; permission?: "pull" | "push" | "admin"; privacy?: "secret" | "closed"; repo_names?: string[] }

Type declaration

  • Optional description?: undefined | string

    The description of the team.

  • Optional maintainers?: string[]

    List GitHub IDs for organization members who will become team maintainers.

  • name: string

    The name of the team.

  • org: string
  • Optional parent_team_id?: undefined | number

    The ID of a team to set as the parent team.

  • Optional permission?: "pull" | "push" | "admin"

    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. Default: secret For a parent or child team: * closed - visible to all members of this organization. Default for child team: closed

  • Optional repo_names?: string[]

    The full name (e.g., "organization-name/repository-name") of repositories to add the team to.

TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint

TeamsCreateOrUpdateIdPGroupConnectionsInOrgEndpoint: { groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups[]; org: string; team_slug: string }

Type declaration

  • groups: TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups[]

    The IdP groups you want to connect to a GitHub team. When updating, the new groups object will replace the original one. You must include any existing groups that you don't want to remove.

  • org: string
  • team_slug: string

TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups

TeamsCreateOrUpdateIdPGroupConnectionsInOrgParamsGroups: { group_description: string; group_id: string; group_name: string }

Type declaration

  • group_description: string
  • group_id: string
  • group_name: string

TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions

TeamsCreateOrUpdateIdPGroupConnectionsInOrgRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/team-sync/group-mappings" }

Type declaration

TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint

TeamsCreateOrUpdateIdPGroupConnectionsLegacyEndpoint: { groups: TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups[]; team_id: number }

Type declaration

TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups

TeamsCreateOrUpdateIdPGroupConnectionsLegacyParamsGroups: { group_description: string; group_id: string; group_name: string }

Type declaration

  • group_description: string
  • group_id: string
  • group_name: string

TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions

TeamsCreateOrUpdateIdPGroupConnectionsLegacyRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/teams/:team_id/team-sync/group-mappings" }

Type declaration

TeamsCreateRequestOptions

TeamsCreateRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/orgs/:org/teams" }

Type declaration

TeamsDeleteDiscussionCommentInOrgEndpoint

TeamsDeleteDiscussionCommentInOrgEndpoint: { comment_number: number; discussion_number: number; org: string; team_slug: string }

Type declaration

  • comment_number: number
  • discussion_number: number
  • org: string
  • team_slug: string

TeamsDeleteDiscussionCommentInOrgRequestOptions

TeamsDeleteDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number" }

Type declaration

TeamsDeleteDiscussionCommentLegacyEndpoint

TeamsDeleteDiscussionCommentLegacyEndpoint: { comment_number: number; discussion_number: number; team_id: number }

Type declaration

  • comment_number: number
  • discussion_number: number
  • team_id: number

TeamsDeleteDiscussionCommentLegacyRequestOptions

TeamsDeleteDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" }

Type declaration

TeamsDeleteDiscussionInOrgEndpoint

TeamsDeleteDiscussionInOrgEndpoint: { discussion_number: number; org: string; team_slug: string }

Type declaration

  • discussion_number: number
  • org: string
  • team_slug: string

TeamsDeleteDiscussionInOrgRequestOptions

TeamsDeleteDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number" }

Type declaration

TeamsDeleteDiscussionLegacyEndpoint

TeamsDeleteDiscussionLegacyEndpoint: { discussion_number: number; team_id: number }

Type declaration

  • discussion_number: number
  • team_id: number

TeamsDeleteDiscussionLegacyRequestOptions

TeamsDeleteDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number" }

Type declaration

TeamsDeleteInOrgEndpoint

TeamsDeleteInOrgEndpoint: { org: string; team_slug: string }

Type declaration

  • org: string
  • team_slug: string

TeamsDeleteInOrgRequestOptions

TeamsDeleteInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug" }

Type declaration

TeamsDeleteLegacyEndpoint

TeamsDeleteLegacyEndpoint: { team_id: number }

Type declaration

  • team_id: number

TeamsDeleteLegacyRequestOptions

TeamsDeleteLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id" }

Type declaration

TeamsGetByNameEndpoint

TeamsGetByNameEndpoint: { org: string; team_slug: string }

Type declaration

  • org: string
  • team_slug: string

TeamsGetByNameRequestOptions

TeamsGetByNameRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug" }

Type declaration

TeamsGetDiscussionCommentInOrgEndpoint

TeamsGetDiscussionCommentInOrgEndpoint: { comment_number: number; discussion_number: number; org: string; team_slug: string }

Type declaration

  • comment_number: number
  • discussion_number: number
  • org: string
  • team_slug: string

TeamsGetDiscussionCommentInOrgRequestOptions

TeamsGetDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number" }

Type declaration

TeamsGetDiscussionCommentLegacyEndpoint

TeamsGetDiscussionCommentLegacyEndpoint: { comment_number: number; discussion_number: number; team_id: number }

Type declaration

  • comment_number: number
  • discussion_number: number
  • team_id: number

TeamsGetDiscussionCommentLegacyRequestOptions

TeamsGetDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" }

Type declaration

TeamsGetDiscussionInOrgEndpoint

TeamsGetDiscussionInOrgEndpoint: { discussion_number: number; org: string; team_slug: string }

Type declaration

  • discussion_number: number
  • org: string
  • team_slug: string

TeamsGetDiscussionInOrgRequestOptions

TeamsGetDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number" }

Type declaration

TeamsGetDiscussionLegacyEndpoint

TeamsGetDiscussionLegacyEndpoint: { discussion_number: number; team_id: number }

Type declaration

  • discussion_number: number
  • team_id: number

TeamsGetDiscussionLegacyRequestOptions

TeamsGetDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number" }

Type declaration

TeamsGetLegacyEndpoint

TeamsGetLegacyEndpoint: { team_id: number }

Type declaration

  • team_id: number

TeamsGetLegacyRequestOptions

TeamsGetLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id" }

Type declaration

TeamsGetMemberLegacyEndpoint

TeamsGetMemberLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number
  • username: string

TeamsGetMemberLegacyRequestOptions

TeamsGetMemberLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/members/:username" }

Type declaration

TeamsGetMembershipForUserInOrgEndpoint

TeamsGetMembershipForUserInOrgEndpoint: { org: string; team_slug: string; username: string }

Type declaration

  • org: string
  • team_slug: string
  • username: string

TeamsGetMembershipForUserInOrgRequestOptions

TeamsGetMembershipForUserInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/memberships/:username" }

Type declaration

TeamsGetMembershipForUserLegacyEndpoint

TeamsGetMembershipForUserLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number
  • username: string

TeamsGetMembershipForUserLegacyRequestOptions

TeamsGetMembershipForUserLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/memberships/:username" }

Type declaration

TeamsListChildInOrgEndpoint

TeamsListChildInOrgEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_slug: string

TeamsListChildInOrgRequestOptions

TeamsListChildInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/teams" }

Type declaration

TeamsListChildInOrgResponseData

TeamsListChildInOrgResponseData: { description: string; id: number; members_url: string; name: string; node_id: string; parent: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; permission: string; privacy: string; repositories_url: string; slug: string; url: string }; permission: string; privacy: string; repositories_url: string; slug: string; url: string }[]

TeamsListChildLegacyEndpoint

TeamsListChildLegacyEndpoint: { page?: undefined | number; per_page?: undefined | number; team_id: number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

TeamsListChildLegacyRequestOptions

TeamsListChildLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/teams" }

Type declaration

TeamsListChildLegacyResponseData

TeamsListChildLegacyResponseData: { description: string; id: number; members_url: string; name: string; node_id: string; parent: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; permission: string; privacy: string; repositories_url: string; slug: string; url: string }; permission: string; privacy: string; repositories_url: string; slug: string; url: string }[]

TeamsListDiscussionCommentsInOrgEndpoint

TeamsListDiscussionCommentsInOrgEndpoint: { direction?: "asc" | "desc"; discussion_number: number; org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • discussion_number: number
  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_slug: string

TeamsListDiscussionCommentsInOrgRequestOptions

TeamsListDiscussionCommentsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments" }

Type declaration

TeamsListDiscussionCommentsInOrgResponseData

TeamsListDiscussionCommentsInOrgResponseData: { author: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: string; node_id: string; number: number; reactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }; updated_at: string; url: string }[]

TeamsListDiscussionCommentsLegacyEndpoint

TeamsListDiscussionCommentsLegacyEndpoint: { direction?: "asc" | "desc"; discussion_number: number; page?: undefined | number; per_page?: undefined | number; team_id: number }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • discussion_number: number
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

TeamsListDiscussionCommentsLegacyRequestOptions

TeamsListDiscussionCommentsLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments" }

Type declaration

TeamsListDiscussionCommentsLegacyResponseData

TeamsListDiscussionCommentsLegacyResponseData: { author: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; body: string; body_html: string; body_version: string; created_at: string; discussion_url: string; html_url: string; last_edited_at: string; node_id: string; number: number; reactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }; updated_at: string; url: string }[]

TeamsListDiscussionsInOrgEndpoint

TeamsListDiscussionsInOrgEndpoint: { direction?: "asc" | "desc"; org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_slug: string

TeamsListDiscussionsInOrgRequestOptions

TeamsListDiscussionsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions" }

Type declaration

TeamsListDiscussionsInOrgResponseData

TeamsListDiscussionsInOrgResponseData: { author: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: string; node_id: string; number: number; pinned: boolean; private: boolean; reactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }; team_url: string; title: string; updated_at: string; url: string }[]

TeamsListDiscussionsLegacyEndpoint

TeamsListDiscussionsLegacyEndpoint: { direction?: "asc" | "desc"; page?: undefined | number; per_page?: undefined | number; team_id: number }

Type declaration

  • Optional direction?: "asc" | "desc"

    Sorts the discussion comments by the date they were created. To return the oldest comments first, set to asc. Can be one of asc or desc.

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

TeamsListDiscussionsLegacyRequestOptions

TeamsListDiscussionsLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/discussions" }

Type declaration

TeamsListDiscussionsLegacyResponseData

TeamsListDiscussionsLegacyResponseData: { author: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; body: string; body_html: string; body_version: string; comments_count: number; comments_url: string; created_at: string; html_url: string; last_edited_at: string; node_id: string; number: number; pinned: boolean; private: boolean; reactions: { +1: number; -1: number; confused: number; heart: number; hooray: number; laugh: number; total_count: number; url: string }; team_url: string; title: string; updated_at: string; url: string }[]

TeamsListEndpoint

TeamsListEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

TeamsListForAuthenticatedUserEndpoint

TeamsListForAuthenticatedUserEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

TeamsListForAuthenticatedUserRequestOptions

TeamsListForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/teams" }

Type declaration

TeamsListForAuthenticatedUserResponseData

TeamsListForAuthenticatedUserResponseData: { created_at: string; description: string; html_url: string; id: number; members_count: number; members_url: string; name: string; node_id: string; organization: { avatar_url: string; blog: string; company: string; created_at: string; description: string; email: string; events_url: string; followers: number; following: number; has_organization_projects: boolean; has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; is_verified: boolean; issues_url: string; location: string; login: string; members_url: string; name: string; node_id: string; public_gists: number; public_members_url: string; public_repos: number; repos_url: string; twitter_username: string; type: string; url: string }; parent: {}; permission: string; privacy: string; repos_count: number; repositories_url: string; slug: string; updated_at: string; url: string }[]

TeamsListIdPGroupsForLegacyEndpoint

TeamsListIdPGroupsForLegacyEndpoint: { team_id: number }

Type declaration

  • team_id: number

TeamsListIdPGroupsForLegacyRequestOptions

TeamsListIdPGroupsForLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/team-sync/group-mappings" }

Type declaration

TeamsListIdPGroupsForOrgEndpoint

TeamsListIdPGroupsForOrgEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

TeamsListIdPGroupsForOrgRequestOptions

TeamsListIdPGroupsForOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/team-sync/groups" }

Type declaration

TeamsListIdPGroupsInOrgEndpoint

TeamsListIdPGroupsInOrgEndpoint: { org: string; team_slug: string }

Type declaration

  • org: string
  • team_slug: string

TeamsListIdPGroupsInOrgRequestOptions

TeamsListIdPGroupsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/team-sync/group-mappings" }

Type declaration

TeamsListMembersInOrgEndpoint

TeamsListMembersInOrgEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number; role?: "member" | "maintainer" | "all"; team_slug: string }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional role?: "member" | "maintainer" | "all"

    Filters members returned by their role in the team. Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team.

  • team_slug: string

TeamsListMembersInOrgRequestOptions

TeamsListMembersInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/members" }

Type declaration

TeamsListMembersInOrgResponseData

TeamsListMembersInOrgResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

TeamsListMembersLegacyEndpoint

TeamsListMembersLegacyEndpoint: { page?: undefined | number; per_page?: undefined | number; role?: "member" | "maintainer" | "all"; team_id: number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • Optional role?: "member" | "maintainer" | "all"

    Filters members returned by their role in the team. Can be one of: * member - normal members of the team. * maintainer - team maintainers. * all - all members of the team.

  • team_id: number

TeamsListMembersLegacyRequestOptions

TeamsListMembersLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/members" }

Type declaration

TeamsListMembersLegacyResponseData

TeamsListMembersLegacyResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

TeamsListPendingInvitationsInOrgEndpoint

TeamsListPendingInvitationsInOrgEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_slug: string

TeamsListPendingInvitationsInOrgRequestOptions

TeamsListPendingInvitationsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/invitations" }

Type declaration

TeamsListPendingInvitationsInOrgResponseData

TeamsListPendingInvitationsInOrgResponseData: { created_at: string; email: string; id: number; invitation_team_url: string; inviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; login: string; role: string; team_count: number }[]

TeamsListPendingInvitationsLegacyEndpoint

TeamsListPendingInvitationsLegacyEndpoint: { page?: undefined | number; per_page?: undefined | number; team_id: number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

TeamsListPendingInvitationsLegacyRequestOptions

TeamsListPendingInvitationsLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/invitations" }

Type declaration

TeamsListPendingInvitationsLegacyResponseData

TeamsListPendingInvitationsLegacyResponseData: { created_at: string; email: string; id: number; invitation_team_url: string; inviter: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; login: string; role: string; team_count: number }[]

TeamsListProjectsInOrgEndpoint

TeamsListProjectsInOrgEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string } & RequiredPreview<"inertia">

TeamsListProjectsInOrgRequestOptions

TeamsListProjectsInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/projects" }

Type declaration

TeamsListProjectsInOrgResponseData

TeamsListProjectsInOrgResponseData: { body: string; columns_url: string; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; html_url: string; id: number; name: string; node_id: string; number: number; organization_permission: string; owner_url: string; permissions: { admin: boolean; read: boolean; write: boolean }; private: boolean; state: string; updated_at: string; url: string }[]

TeamsListProjectsLegacyEndpoint

TeamsListProjectsLegacyEndpoint: { page?: undefined | number; per_page?: undefined | number; team_id: number } & RequiredPreview<"inertia">

TeamsListProjectsLegacyRequestOptions

TeamsListProjectsLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/projects" }

Type declaration

TeamsListProjectsLegacyResponseData

TeamsListProjectsLegacyResponseData: { body: string; columns_url: string; created_at: string; creator: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; html_url: string; id: number; name: string; node_id: string; number: number; organization_permission: string; owner_url: string; permissions: { admin: boolean; read: boolean; write: boolean }; private: boolean; state: string; updated_at: string; url: string }[]

TeamsListReposInOrgEndpoint

TeamsListReposInOrgEndpoint: { org: string; page?: undefined | number; per_page?: undefined | number; team_slug: string }

Type declaration

  • org: string
  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_slug: string

TeamsListReposInOrgRequestOptions

TeamsListReposInOrgRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/repos" }

Type declaration

TeamsListReposInOrgResponseData

TeamsListReposInOrgResponseData: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; license: { key: string; name: string; node_id: string; spdx_id: string; url: string }; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }[]

TeamsListReposLegacyEndpoint

TeamsListReposLegacyEndpoint: { page?: undefined | number; per_page?: undefined | number; team_id: number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • team_id: number

TeamsListReposLegacyRequestOptions

TeamsListReposLegacyRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/teams/:team_id/repos" }

Type declaration

TeamsListReposLegacyResponseData

TeamsListReposLegacyResponseData: { archive_url: string; archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; created_at: string; default_branch: string; delete_branch_on_merge: boolean; deployments_url: string; description: string; disabled: boolean; downloads_url: string; events_url: string; fork: boolean; forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; has_downloads: boolean; has_issues: boolean; has_pages: boolean; has_projects: boolean; has_wiki: boolean; homepage: string; hooks_url: string; html_url: string; id: number; is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; language: string; languages_url: string; license: { key: string; name: string; node_id: string; spdx_id: string; url: string }; merges_url: string; milestones_url: string; mirror_url: string; name: string; network_count: number; node_id: string; notifications_url: string; open_issues_count: number; owner: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }; permissions: { admin: boolean; pull: boolean; push: boolean }; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; ssh_url: string; stargazers_count: number; stargazers_url: string; statuses_url: string; subscribers_count: number; subscribers_url: string; subscription_url: string; svn_url: string; tags_url: string; teams_url: string; temp_clone_token: string; template_repository: {}; topics: string[]; trees_url: string; updated_at: string; url: string; visibility: string; watchers_count: number }[]

TeamsListRequestOptions

TeamsListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/orgs/:org/teams" }

Type declaration

TeamsListResponseData

TeamsListResponseData: { description: string; html_url: string; id: number; members_url: string; name: string; node_id: string; parent: {}; permission: string; privacy: string; repositories_url: string; slug: string; url: string }[]

TeamsRemoveMemberLegacyEndpoint

TeamsRemoveMemberLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number
  • username: string

TeamsRemoveMemberLegacyRequestOptions

TeamsRemoveMemberLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id/members/:username" }

Type declaration

TeamsRemoveMembershipForUserInOrgEndpoint

TeamsRemoveMembershipForUserInOrgEndpoint: { org: string; team_slug: string; username: string }

Type declaration

  • org: string
  • team_slug: string
  • username: string

TeamsRemoveMembershipForUserInOrgRequestOptions

TeamsRemoveMembershipForUserInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/memberships/:username" }

Type declaration

TeamsRemoveMembershipForUserLegacyEndpoint

TeamsRemoveMembershipForUserLegacyEndpoint: { team_id: number; username: string }

Type declaration

  • team_id: number
  • username: string

TeamsRemoveMembershipForUserLegacyRequestOptions

TeamsRemoveMembershipForUserLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id/memberships/:username" }

Type declaration

TeamsRemoveProjectInOrgEndpoint

TeamsRemoveProjectInOrgEndpoint: { org: string; project_id: number; team_slug: string }

Type declaration

  • org: string
  • project_id: number
  • team_slug: string

TeamsRemoveProjectInOrgRequestOptions

TeamsRemoveProjectInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/projects/:project_id" }

Type declaration

TeamsRemoveProjectLegacyEndpoint

TeamsRemoveProjectLegacyEndpoint: { project_id: number; team_id: number }

Type declaration

  • project_id: number
  • team_id: number

TeamsRemoveProjectLegacyRequestOptions

TeamsRemoveProjectLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id/projects/:project_id" }

Type declaration

TeamsRemoveRepoInOrgEndpoint

TeamsRemoveRepoInOrgEndpoint: { org: string; owner: string; repo: string; team_slug: string }

Type declaration

  • org: string
  • owner: string
  • repo: string
  • team_slug: string

TeamsRemoveRepoInOrgRequestOptions

TeamsRemoveRepoInOrgRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo" }

Type declaration

TeamsRemoveRepoLegacyEndpoint

TeamsRemoveRepoLegacyEndpoint: { owner: string; repo: string; team_id: number }

Type declaration

  • owner: string
  • repo: string
  • team_id: number

TeamsRemoveRepoLegacyRequestOptions

TeamsRemoveRepoLegacyRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/teams/:team_id/repos/:owner/:repo" }

Type declaration

TeamsUpdateDiscussionCommentInOrgEndpoint

TeamsUpdateDiscussionCommentInOrgEndpoint: { body: string; comment_number: number; discussion_number: number; org: string; team_slug: string }

Type declaration

  • body: string

    The discussion comment's body text.

  • comment_number: number
  • discussion_number: number
  • org: string
  • team_slug: string

TeamsUpdateDiscussionCommentInOrgRequestOptions

TeamsUpdateDiscussionCommentInOrgRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number" }

Type declaration

TeamsUpdateDiscussionCommentLegacyEndpoint

TeamsUpdateDiscussionCommentLegacyEndpoint: { body: string; comment_number: number; discussion_number: number; team_id: number }

Type declaration

  • body: string

    The discussion comment's body text.

  • comment_number: number
  • discussion_number: number
  • team_id: number

TeamsUpdateDiscussionCommentLegacyRequestOptions

TeamsUpdateDiscussionCommentLegacyRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" }

Type declaration

TeamsUpdateDiscussionInOrgEndpoint

TeamsUpdateDiscussionInOrgEndpoint: { body?: undefined | string; discussion_number: number; org: string; team_slug: string; title?: undefined | string }

Type declaration

  • Optional body?: undefined | string

    The discussion post's body text.

  • discussion_number: number
  • org: string
  • team_slug: string
  • Optional title?: undefined | string

    The discussion post's title.

TeamsUpdateDiscussionInOrgRequestOptions

TeamsUpdateDiscussionInOrgRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number" }

Type declaration

TeamsUpdateDiscussionLegacyEndpoint

TeamsUpdateDiscussionLegacyEndpoint: { body?: undefined | string; discussion_number: number; team_id: number; title?: undefined | string }

Type declaration

  • Optional body?: undefined | string

    The discussion post's body text.

  • discussion_number: number
  • team_id: number
  • Optional title?: undefined | string

    The discussion post's title.

TeamsUpdateDiscussionLegacyRequestOptions

TeamsUpdateDiscussionLegacyRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/teams/:team_id/discussions/:discussion_number" }

Type declaration

TeamsUpdateInOrgEndpoint

TeamsUpdateInOrgEndpoint: { description?: undefined | string; name: string; org: string; parent_team_id?: undefined | number; permission?: "pull" | "push" | "admin"; privacy?: "secret" | "closed"; team_slug: string }

Type declaration

  • Optional description?: undefined | string

    The description of the team.

  • name: string

    The name of the team.

  • org: string
  • Optional parent_team_id?: undefined | number

    The ID of a team to set as the parent team.

  • Optional permission?: "pull" | "push" | "admin"

    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

  • team_slug: string

TeamsUpdateInOrgRequestOptions

TeamsUpdateInOrgRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/orgs/:org/teams/:team_slug" }

Type declaration

TeamsUpdateLegacyEndpoint

TeamsUpdateLegacyEndpoint: { description?: undefined | string; name: string; parent_team_id?: undefined | number; permission?: "pull" | "push" | "admin"; privacy?: "secret" | "closed"; team_id: number }

Type declaration

  • Optional description?: undefined | string

    The description of the team.

  • name: string

    The name of the team.

  • Optional parent_team_id?: undefined | number

    The ID of a team to set as the parent team.

  • Optional permission?: "pull" | "push" | "admin"

    Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of: * pull - team members can pull, but not push to or administer newly-added repositories. * push - team members can pull and push, but not administer newly-added repositories. * admin - team members can pull, push and administer newly-added repositories.

  • Optional privacy?: "secret" | "closed"

    The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. The options are: For a non-nested team: * secret - only visible to organization owners and members of this team. * closed - visible to all members of this organization. For a parent or child team: * closed - visible to all members of this organization.

  • team_id: number

TeamsUpdateLegacyRequestOptions

TeamsUpdateLegacyRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/teams/:team_id" }

Type declaration

UsersAddEmailForAuthenticatedEndpoint

UsersAddEmailForAuthenticatedEndpoint: { emails: string[] }

Type declaration

  • emails: string[]

    Adds one or more email addresses to your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

UsersAddEmailForAuthenticatedRequestOptions

UsersAddEmailForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/user/emails" }

Type declaration

UsersAddEmailForAuthenticatedResponseData

UsersAddEmailForAuthenticatedResponseData: { email: string; primary: boolean; verified: boolean; visibility: string }[]

UsersBlockEndpoint

UsersBlockEndpoint: { username: string }

Type declaration

  • username: string

UsersBlockRequestOptions

UsersBlockRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/user/blocks/:username" }

Type declaration

UsersCheckBlockedEndpoint

UsersCheckBlockedEndpoint: { username: string }

Type declaration

  • username: string

UsersCheckBlockedRequestOptions

UsersCheckBlockedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/blocks/:username" }

Type declaration

UsersCheckFollowingForUserEndpoint

UsersCheckFollowingForUserEndpoint: { target_user: string; username: string }

Type declaration

  • target_user: string
  • username: string

UsersCheckFollowingForUserRequestOptions

UsersCheckFollowingForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/following/:target_user" }

Type declaration

UsersCheckPersonIsFollowedByAuthenticatedEndpoint

UsersCheckPersonIsFollowedByAuthenticatedEndpoint: { username: string }

Type declaration

  • username: string

UsersCheckPersonIsFollowedByAuthenticatedRequestOptions

UsersCheckPersonIsFollowedByAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/following/:username" }

Type declaration

UsersCreateGpgKeyForAuthenticatedEndpoint

UsersCreateGpgKeyForAuthenticatedEndpoint: { armored_public_key?: undefined | string }

Type declaration

  • Optional armored_public_key?: undefined | string

    Your GPG key, generated in ASCII-armored format. See "Generating a new GPG key" for help creating a GPG key.

UsersCreateGpgKeyForAuthenticatedRequestOptions

UsersCreateGpgKeyForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/user/gpg_keys" }

Type declaration

UsersCreatePublicSshKeyForAuthenticatedEndpoint

UsersCreatePublicSshKeyForAuthenticatedEndpoint: { key?: undefined | string; title?: undefined | string }

Type declaration

  • Optional key?: undefined | string

    The public SSH key to add to your GitHub account. See "Generating a new SSH key" for guidance on how to create a public SSH key.

  • Optional title?: undefined | string

    A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key "Personal MacBook Air".

UsersCreatePublicSshKeyForAuthenticatedRequestOptions

UsersCreatePublicSshKeyForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "POST"; request: RequestRequestOptions; url: "/user/keys" }

Type declaration

UsersDeleteEmailForAuthenticatedEndpoint

UsersDeleteEmailForAuthenticatedEndpoint: { emails: string[] }

Type declaration

  • emails: string[]

    Deletes one or more email addresses from your GitHub account. Must contain at least one email address. Note: Alternatively, you can pass a single email address or an array of emails addresses directly, but we recommend that you pass an object using the emails key.

UsersDeleteEmailForAuthenticatedRequestOptions

UsersDeleteEmailForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/emails" }

Type declaration

UsersDeleteGpgKeyForAuthenticatedEndpoint

UsersDeleteGpgKeyForAuthenticatedEndpoint: { gpg_key_id: number }

Type declaration

  • gpg_key_id: number

UsersDeleteGpgKeyForAuthenticatedRequestOptions

UsersDeleteGpgKeyForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/gpg_keys/:gpg_key_id" }

Type declaration

UsersDeletePublicSshKeyForAuthenticatedEndpoint

UsersDeletePublicSshKeyForAuthenticatedEndpoint: { key_id: number }

Type declaration

  • key_id: number

UsersDeletePublicSshKeyForAuthenticatedRequestOptions

UsersDeletePublicSshKeyForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/keys/:key_id" }

Type declaration

UsersFollowEndpoint

UsersFollowEndpoint: { username: string }

Type declaration

  • username: string

UsersFollowRequestOptions

UsersFollowRequestOptions: { headers: RequestHeaders; method: "PUT"; request: RequestRequestOptions; url: "/user/following/:username" }

Type declaration

UsersGetAuthenticatedEndpoint

UsersGetAuthenticatedEndpoint: {}

Type declaration

UsersGetAuthenticatedRequestOptions

UsersGetAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user" }

Type declaration

UsersGetByUsernameEndpoint

UsersGetByUsernameEndpoint: { username: string }

Type declaration

  • username: string

UsersGetByUsernameRequestOptions

UsersGetByUsernameRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username" }

Type declaration

UsersGetContextForUserEndpoint

UsersGetContextForUserEndpoint: { subject_id?: undefined | string; subject_type?: "organization" | "repository" | "issue" | "pull_request"; username: string }

Type declaration

  • Optional subject_id?: undefined | string

    Uses the ID for the subject_type you specified. Required when using subject_type.

  • Optional subject_type?: "organization" | "repository" | "issue" | "pull_request"

    Identifies which additional information you'd like to receive about the person's hovercard. Can be organization, repository, issue, pull_request. Required when using subject_id.

  • username: string

UsersGetContextForUserRequestOptions

UsersGetContextForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/hovercard" }

Type declaration

UsersGetGpgKeyForAuthenticatedEndpoint

UsersGetGpgKeyForAuthenticatedEndpoint: { gpg_key_id: number }

Type declaration

  • gpg_key_id: number

UsersGetGpgKeyForAuthenticatedRequestOptions

UsersGetGpgKeyForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/gpg_keys/:gpg_key_id" }

Type declaration

UsersGetPublicSshKeyForAuthenticatedEndpoint

UsersGetPublicSshKeyForAuthenticatedEndpoint: { key_id: number }

Type declaration

  • key_id: number

UsersGetPublicSshKeyForAuthenticatedRequestOptions

UsersGetPublicSshKeyForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/keys/:key_id" }

Type declaration

UsersListBlockedByAuthenticatedEndpoint

UsersListBlockedByAuthenticatedEndpoint: {}

Type declaration

UsersListBlockedByAuthenticatedRequestOptions

UsersListBlockedByAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/blocks" }

Type declaration

UsersListBlockedByAuthenticatedResponseData

UsersListBlockedByAuthenticatedResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

UsersListEmailsForAuthenticatedEndpoint

UsersListEmailsForAuthenticatedEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

UsersListEmailsForAuthenticatedRequestOptions

UsersListEmailsForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/emails" }

Type declaration

UsersListEmailsForAuthenticatedResponseData

UsersListEmailsForAuthenticatedResponseData: { email: string; primary: boolean; verified: boolean; visibility: string }[]

UsersListEndpoint

UsersListEndpoint: { since?: undefined | string }

Type declaration

  • Optional since?: undefined | string

    The integer ID of the last User that you've seen.

UsersListFollowedByAuthenticatedEndpoint

UsersListFollowedByAuthenticatedEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

UsersListFollowedByAuthenticatedRequestOptions

UsersListFollowedByAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/following" }

Type declaration

UsersListFollowedByAuthenticatedResponseData

UsersListFollowedByAuthenticatedResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

UsersListFollowersForAuthenticatedUserEndpoint

UsersListFollowersForAuthenticatedUserEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

UsersListFollowersForAuthenticatedUserRequestOptions

UsersListFollowersForAuthenticatedUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/followers" }

Type declaration

UsersListFollowersForAuthenticatedUserResponseData

UsersListFollowersForAuthenticatedUserResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

UsersListFollowersForUserEndpoint

UsersListFollowersForUserEndpoint: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

UsersListFollowersForUserRequestOptions

UsersListFollowersForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/followers" }

Type declaration

UsersListFollowersForUserResponseData

UsersListFollowersForUserResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

UsersListFollowingForUserEndpoint

UsersListFollowingForUserEndpoint: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

UsersListFollowingForUserRequestOptions

UsersListFollowingForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/following" }

Type declaration

UsersListFollowingForUserResponseData

UsersListFollowingForUserResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

UsersListGpgKeysForAuthenticatedEndpoint

UsersListGpgKeysForAuthenticatedEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

UsersListGpgKeysForAuthenticatedRequestOptions

UsersListGpgKeysForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/gpg_keys" }

Type declaration

UsersListGpgKeysForAuthenticatedResponseData

UsersListGpgKeysForAuthenticatedResponseData: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: { email: string; verified: boolean }[]; expires_at: string; id: number; key_id: string; primary_key_id: string; public_key: string; subkeys: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: unknown[]; expires_at: string; id: number; key_id: string; primary_key_id: number; public_key: string; subkeys: unknown[] }[] }[]

UsersListGpgKeysForUserEndpoint

UsersListGpgKeysForUserEndpoint: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

UsersListGpgKeysForUserRequestOptions

UsersListGpgKeysForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/gpg_keys" }

Type declaration

UsersListGpgKeysForUserResponseData

UsersListGpgKeysForUserResponseData: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: { email: string; verified: boolean }[]; expires_at: string; id: number; key_id: string; primary_key_id: string; public_key: string; subkeys: { can_certify: boolean; can_encrypt_comms: boolean; can_encrypt_storage: boolean; can_sign: boolean; created_at: string; emails: unknown[]; expires_at: string; id: number; key_id: string; primary_key_id: number; public_key: string; subkeys: unknown[] }[] }[]

UsersListPublicEmailsForAuthenticatedEndpoint

UsersListPublicEmailsForAuthenticatedEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

UsersListPublicEmailsForAuthenticatedRequestOptions

UsersListPublicEmailsForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/public_emails" }

Type declaration

UsersListPublicEmailsForAuthenticatedResponseData

UsersListPublicEmailsForAuthenticatedResponseData: { email: string; primary: boolean; verified: boolean; visibility: string }[]

UsersListPublicKeysForUserEndpoint

UsersListPublicKeysForUserEndpoint: { page?: undefined | number; per_page?: undefined | number; username: string }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

  • username: string

UsersListPublicKeysForUserRequestOptions

UsersListPublicKeysForUserRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users/:username/keys" }

Type declaration

UsersListPublicKeysForUserResponseData

UsersListPublicKeysForUserResponseData: { id: number; key: string }[]

UsersListPublicSshKeysForAuthenticatedEndpoint

UsersListPublicSshKeysForAuthenticatedEndpoint: { page?: undefined | number; per_page?: undefined | number }

Type declaration

  • Optional page?: undefined | number

    Page number of the results to fetch.

  • Optional per_page?: undefined | number

    Results per page (max 100)

UsersListPublicSshKeysForAuthenticatedRequestOptions

UsersListPublicSshKeysForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/user/keys" }

Type declaration

UsersListPublicSshKeysForAuthenticatedResponseData

UsersListPublicSshKeysForAuthenticatedResponseData: { key: string; key_id: string }[]

UsersListRequestOptions

UsersListRequestOptions: { headers: RequestHeaders; method: "GET"; request: RequestRequestOptions; url: "/users" }

Type declaration

UsersListResponseData

UsersListResponseData: { avatar_url: string; events_url: string; followers_url: string; following_url: string; gists_url: string; gravatar_id: string; html_url: string; id: number; login: string; node_id: string; organizations_url: string; received_events_url: string; repos_url: string; site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string }[]

UsersSetPrimaryEmailVisibilityForAuthenticatedEndpoint

UsersSetPrimaryEmailVisibilityForAuthenticatedEndpoint: { email: string; visibility: string }

Type declaration

  • email: string

    Specify the primary email address that needs a visibility change.

  • visibility: string

    Use public to enable an authenticated user to view the specified email address, or use private so this primary email address cannot be seen publicly.

UsersSetPrimaryEmailVisibilityForAuthenticatedRequestOptions

UsersSetPrimaryEmailVisibilityForAuthenticatedRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/user/email/visibility" }

Type declaration

UsersSetPrimaryEmailVisibilityForAuthenticatedResponseData

UsersSetPrimaryEmailVisibilityForAuthenticatedResponseData: { email: string; primary: boolean; verified: boolean; visibility: string }[]

UsersUnblockEndpoint

UsersUnblockEndpoint: { username: string }

Type declaration

  • username: string

UsersUnblockRequestOptions

UsersUnblockRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/blocks/:username" }

Type declaration

UsersUnfollowEndpoint

UsersUnfollowEndpoint: { username: string }

Type declaration

  • username: string

UsersUnfollowRequestOptions

UsersUnfollowRequestOptions: { headers: RequestHeaders; method: "DELETE"; request: RequestRequestOptions; url: "/user/following/:username" }

Type declaration

UsersUpdateAuthenticatedEndpoint

UsersUpdateAuthenticatedEndpoint: { bio?: undefined | string; blog?: undefined | string; company?: undefined | string; email?: undefined | string; hireable?: undefined | false | true; location?: undefined | string; name?: undefined | string; twitter_username?: undefined | string }

Type declaration

  • Optional bio?: undefined | string

    The new short biography of the user.

  • Optional blog?: undefined | string

    The new blog URL of the user.

  • Optional company?: undefined | string

    The new company of the user.

  • Optional email?: undefined | string

    The publicly visible email address of the user.

  • Optional hireable?: undefined | false | true

    The new hiring availability of the user.

  • Optional location?: undefined | string

    The new location of the user.

  • Optional name?: undefined | string

    The new name of the user.

  • Optional twitter_username?: undefined | string

    The new Twitter username of the user.

UsersUpdateAuthenticatedRequestOptions

UsersUpdateAuthenticatedRequestOptions: { headers: RequestHeaders; method: "PATCH"; request: RequestRequestOptions; url: "/user" }

Type declaration

Generated using TypeDoc